docusaurus/packages/create-docusaurus
2021-12-17 11:38:26 +01:00
..
bin chore: upgrade TypeScript & other ESLint related deps (#5963) 2021-11-18 21:15:37 +08:00
src fix(create-docusaurus): give a clearer message when installation failed (#6095) 2021-12-15 18:03:38 +01:00
templates fix(create-docusaurus): make initial editUrl functional (#6119) 2021-12-17 10:47:58 +08:00
.npmignore misc: ignore some files during npm publish (#6092) 2021-12-17 11:38:26 +01:00
package.json chore(v2): prepare v2.0.0-beta.13 release (#6084) 2021-12-10 16:56:00 +01:00
README.md feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00
tsconfig.json feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00

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