docusaurus/packages/create-docusaurus
Nayan Patel 7fcadd0c36
docs: make installation guide more beginner-friendly (#6187)
* Add support for beginners

* Add files via upload

* Update intro.md

* Update intro.md

* Update intro.md

* Update intro.md

* Update intro.md

* Edits

* Edits

* Last nits

* Edit

* Update installation.md

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-12-26 19:29:47 +08:00
..
bin refactor: unify log format with new logger utility (#5994) 2021-12-20 17:24:59 +01:00
src refactor: print trailing new line when outputting JSON (#6186) 2021-12-24 22:11:35 +08:00
templates docs: make installation guide more beginner-friendly (#6187) 2021-12-26 19:29:47 +08:00
.npmignore misc: ignore some files during npm publish (#6092) 2021-12-17 11:38:26 +01: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