History

Sachin Nanayakkara be0ac6c2cd fix(create): add missing await (#8831 )		2023-03-28 12:28:34 -04:00
..
bin	…
src	fix(create): add missing await (#8831 )	2023-03-28 12:28:34 -04:00
templates	polish(create-docusaurus): the starter template should use a navbar item "docSidebar" instead of "doc" (less fragile on updates) (#8712 )	2023-03-16 17:18:42 +01:00
.npmignore	…
README.md	…
package.json	…
tsconfig.build.json	…
tsconfig.json	…

README.md

`create-docusaurus`

Create Docusaurus apps easily with simplified commands:

npm init docusaurus

yarn create docusaurus

Usage

Please see the installation documentation.

For maintainers

For Docusaurus maintainers, templates can be tested with:

cd `git rev-parse --show-toplevel` # Back to repo root
rm -rf test-website
yarn create-docusaurus test-website classic
cd test-website
yarn start

Note: test-website is not part of the workspace and use packages from npm.

Use the following to test the templates against local packages:

cd `git rev-parse --show-toplevel` # Back to repo root
rm -rf test-website-in-workspace
yarn create-docusaurus test-website-in-workspace classic
cd test-website-in-workspace
yarn start