create-docusaurus
v3.10.2
Published
Create Docusaurus apps easily.
Downloads
22,060
Readme
create-docusaurus
Create Docusaurus apps easily with simplified commands:
npm init docusaurusyarn create docusaurusnpx create-docusaurus@latestUsage
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 --javascript
cd test-website
yarn startNote: 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 --javascript
cd test-website-in-workspace
yarn build
yarn startFor the TypeScript template:
cd `git rev-parse --show-toplevel` # Back to repo root
rm -rf test-website-in-workspace
yarn create-docusaurus test-website-in-workspace classic --typescript
cd test-website-in-workspace
yarn typecheck
yarn build
yarn start