docusaurus/packages/create-docusaurus
Joshua Chen b89d93fab5
refactor: recommend using data-theme without html element selector (#6668)
* refactor: recommend using data-theme without html element selector

* simplify site CSS

* refactor
2022-02-14 10:23:42 +08:00
..
bin feat(create): allow specifying a git clone strategy (#6610) 2022-02-10 11:15:06 +08:00
src feat(create): allow specifying a git clone strategy (#6610) 2022-02-10 11:15:06 +08:00
templates refactor: recommend using data-theme without html element selector (#6668) 2022-02-14 10:23:42 +08:00
.npmignore fix(init): cd to correct path when installing (#6468) 2022-01-26 10:01:11 +08:00
package.json chore: upgrade dependencies (#6660) 2022-02-12 15:29:40 +08: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