docusaurus/packages/create-docusaurus
Joshua Chen aeb6c971c0
docs: normalize capitalization (#7613)
2022-06-14 14:01:06 +08:00
..
bin refactor: remove sub-eslintrc, fix more lint errors (#7530) 2022-05-30 14:49:51 +08:00
src
templates docs: normalize capitalization (#7613) 2022-06-14 14:01:06 +08: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