docusaurus/packages/create-docusaurus
sebastienlorber 56410aa946 v2.4.3 2023-09-20 17:41:27 +02:00
..
bin
src chore: backport retro compatible commits for the Docusaurus v2.4.1 release (#8979) 2023-05-15 15:41:07 +02:00
templates v2.4.3 2023-09-20 17:41:27 +02:00
.npmignore
README.md
package.json v2.4.3 2023-09-20 17:41:27 +02:00
tsconfig.build.json chore: upgrade to TS 4.7, compile with NodeNext (#7586) 2022-06-15 19:15:11 +02:00
tsconfig.json chore: upgrade to TS 4.7, compile with NodeNext (#7586) 2022-06-15 19:15:11 +02:00

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