docusaurus-init

docusaurus-init

An initialization script for Docusaurus.

What does it do?

Docusaurus was designed from the ground up to be easily installed and used to get your website up an running quickly. To install Docusaurus, we have created an easy script that will get all of the infrastructure setup for you:

1. Have Node >= 8.x installed. Yarn >= 1.5 is recommended as well.
2. Go into the root of your GitHub repo directory where you will be creating the docs.
3. npx docusaurus-init

If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

Find out more in the official docs.

Changelog

2.0.0-alpha.26 (2019-10-12)

• Docs, pages plugin is rewritten in TypeScript
• Docs improvements and tweaks
  • Improved metadata which results in smaller bundle size.
  • Docs sidebar can now be more than one level deep, theoretically up to infinity
  • Collapsible docs sidebar!
  • Make doc page title larger
  • Add editUrl option (URL for editing) to docs plugin. If this field is set, there will be an "Edit this page" link for each doc page. Example: 'https://github.com/facebook/docusaurus/edit/master/docs'
  • Add showLastUpdateTime and showLastUpdateAuthor options to docs plugin to further achieve v1 parity of showing last update data for a particular doc
• Slight tweaks to the Blog components - blog title is larger now
• Code Blocks
  • Change default theme from Night Owl to Palenight
  • Slight tweaks to playground/preview components
• Add scripts and stylesheets field to docusaurus.config.js
• More documentation...