docusaurus/packages/create-docusaurus
Afshin Mehrabani 54d0755493
feat(create-docusaurus): allow using local folder as template (#3458)
* feat(docusaurus-init): search the local ./templates folder during doc init

* Add docs

Co-authored-by: Josh-Cena <sidachen2003@gmail.com>
2021-11-15 12:37:22 +08:00
..
bin feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00
src feat(create-docusaurus): allow using local folder as template (#3458) 2021-11-15 12:37:22 +08:00
templates feat: allow GIT_USER env var to be unset if SSH is used (#5840) 2021-11-10 18:51:12 +08:00
package.json chore: prepare v2.0.0-beta.9 release (#5859) 2021-11-02 20:40:01 +03: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