docusaurus/packages/create-docusaurus
Joshua Chen 87592bca03
refactor: ensure all types are using index signature instead of Record (#6995)
* refactor: ensure all types are using index signature instead of Record

* kick CI
2022-03-25 18:06:30 +08:00
..
bin fix(create): load entry file after node version checking (#6860) 2022-03-06 22:18:38 +08:00
src refactor: ensure all types are using index signature instead of Record (#6995) 2022-03-25 18:06:30 +08:00
templates chore: upgrade dependencies (#6991) 2022-03-25 10:47:08 +08:00
.npmignore fix(init): cd to correct path when installing (#6468) 2022-01-26 10:01:11 +08:00
package.json refactor: make JS executables included in the tsconfig for editor hints (#6861) 2022-03-06 23:07:23 +08:00
README.md feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00
tsconfig.build.json refactor: make JS executables included in the tsconfig for editor hints (#6861) 2022-03-06 23:07:23 +08:00
tsconfig.json refactor: make JS executables included in the tsconfig for editor hints (#6861) 2022-03-06 23:07:23 +08: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