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

Add readme to docusaurus-init directory

Browse source
This commit is contained in:
Joel Marcey 2017-12-13 15:50:57 -08:00
parent d33489cf16
commit b47dae6ae1
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docusaurus-init/README.md Normal file
View file

@ -0,0 +1,13 @@
## `docusaurus-init`
An initialization script for [Docusaurus](https://docusuarus.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. Go into the root of your GitHub repo directory where you will be creating the docs.
1. `yarn global add docusaurus-init` or `npm install --global docusaurus-init`
1. `docusaurus-init`
Find out more in the [official docs](http://localhost:3000/docs/en/installation.html).