3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-02 11:47:23 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/v1/docusaurus-init
History
Yangshun Tay f2927a9fc4
Move Docusaurus 1 files into directory (#966) 
* Move Docusaurus 1 into v1 directory

* Update Circle CI commands for new v1 dir

* Remove OC

* Fix tests
2018-09-18 00:58:07 +08:00
..
initialize.js Move Docusaurus 1 files into directory (#966) 2018-09-18 00:58:07 +08:00
package-lock.json Move Docusaurus 1 files into directory (#966) 2018-09-18 00:58:07 +08:00
package.json Move Docusaurus 1 files into directory (#966) 2018-09-18 00:58:07 +08:00
README.md Move Docusaurus 1 files into directory (#966) 2018-09-18 00:58:07 +08:00

README.md

docusaurus-init

An initialization script for Docusaurus.

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.
  2. Go into the root of your GitHub repo directory where you will be creating the docs.
  3. 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.