docusaurus/packages/create-docusaurus
Thad Guidry 2a96ec01de
polish(create-docusaurus): add comment in config to mention different ways to declare config + doc link (#8944)
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2023-05-03 18:36:29 +02:00
..
bin
src fix(create): add missing await (#8831) 2023-03-28 12:28:34 -04:00
templates polish(create-docusaurus): add comment in config to mention different ways to declare config + doc link (#8944) 2023-05-03 18:36:29 +02:00
.npmignore
README.md
package.json chore: upgrade dependencies (non-major) (#8749) 2023-03-08 21:28:14 -05:00
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