docusaurus/packages/create-docusaurus
Gabriel Csapo d73b4f8674
fix(init): cd to correct path when installing (#6468)
* [bug] ensure we use the correct cd path

* Update index.ts

* refactor

* add ignore

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2022-01-26 10:01:11 +08:00
..
bin refactor: unify log format with new logger utility (#5994) 2021-12-20 17:24:59 +01:00
src fix(init): cd to correct path when installing (#6468) 2022-01-26 10:01:11 +08:00
templates feat: update website & init template palette to pass WCAG test; include contrast check in ColorGenerator (#5822) 2022-01-20 14:51:18 +08:00
.npmignore fix(init): cd to correct path when installing (#6468) 2022-01-26 10:01:11 +08:00
package.json chore(v2): prepare v2.0.0-beta.14 release (#6147) 2021-12-21 17:15:04 +01: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