mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-09 23:27:28 +02:00
1f91d19a8c
* chore: move to monorepo * lint all js file * simplify circleCI * fix failing tests * fix tests due to folder rename * fix test since v1 website is renamed
15 lines
791 B
Markdown
15 lines
791 B
Markdown
## `docusaurus-init`
|
|
|
|
An initialization script for [Docusaurus](https://docusaurus.io).
|
|
|
|
### What does it do?
|
|
|
|
Docusaurus was designed from the ground up to be easily installed and used to get your website up an running quickly. To install Docusaurus, we have created an easy script that will get all of the infrastructure setup for you:
|
|
|
|
1. Have Node >= 8.x installed. Yarn >= 1.5 is recommended as well.
|
|
1. Go into the root of your GitHub repo directory where you will be creating the docs.
|
|
1. `npx docusaurus-init`
|
|
|
|
> If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.
|
|
|
|
Find out more in the [official docs](https://docusaurus.io/docs/en/installation).
|