3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-02 02:42:41 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat: npm init docusaurus, yarn create docusaurus (#5635)

Browse source 
* 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
This commit is contained in:
Sébastien Lorber 2021-10-07 16:06:42 +02:00 • committed by GitHub
parent e1b4da04fe
commit f6ec757aa0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
102 changed files with 80 additions and 93 deletions
Download patch file Download diff file Expand all files Collapse all files

39
packages/create-docusaurus/README.md Normal file
View file

@ -0,0 +1,39 @@
# `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
```