From b47dae6ae15e4975a3e5a2f848d6d65824be240e Mon Sep 17 00:00:00 2001 From: Joel Marcey Date: Wed, 13 Dec 2017 15:50:57 -0800 Subject: [PATCH] Add readme to docusaurus-init directory --- docusaurus-init/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 docusaurus-init/README.md diff --git a/docusaurus-init/README.md b/docusaurus-init/README.md new file mode 100644 index 0000000000..90aa3b039a --- /dev/null +++ b/docusaurus-init/README.md @@ -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).