mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-01 19:27:48 +02:00
f6ec757aa0
* initial create-docusaurus impl * cleanup * @docusaurus/init renamed to create-docusaurus * 0.0.6 * update lockfile * fix lint * remove npm2yarn for "npm init" because npm2yarn doesn't convert it and yarn result fails to execute * prettier * add correct version * prettier * prettier * prettier * prettier * fix annoying --config .prettierrc issue
39 lines
824 B
Markdown
39 lines
824 B
Markdown
# `create-docusaurus`
|
|
|
|
Create Docusaurus apps easily with simplified commands:
|
|
|
|
```bash
|
|
npm init docusaurus
|
|
```
|
|
|
|
```bash
|
|
yarn create docusaurus
|
|
```
|
|
|
|
## Usage
|
|
|
|
Please see the [installation documentation](https://docusaurus.io/docs/installation).
|
|
|
|
## For maintainers
|
|
|
|
For Docusaurus maintainers, templates can be tested with:
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
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
|
|
```
|