docusaurus/packages/docusaurus-init-1.x/README.md

## `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).
Add readme to docusaurus-init directory 2017-12-13 18:50:57 -05:00			## `docusaurus-init`

A bunch of tiny little fixes for issues I found while setting up docusaurus (#312) * Do not show users related UI if no users have been specified * Fixed typo in Docusaurus homepage link * Allow projects without icons Not every project has an icon, so avoid showing a broken image in that case. * Do not show project icon in the footer if there's no footer icon 2017-12-18 12:26:33 -05:00			`An initialization script for [Docusaurus](https://docusaurus.io).`
Add readme to docusaurus-init directory 2017-12-13 18:50:57 -05:00
			`### 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:`

Bump docusaurus-init to 1.0.2 (#788) 2018-06-19 10:33:24 -04:00			`1. Have Node >= 8.x installed. Yarn >= 1.5 is recommended as well.`
Add readme to docusaurus-init directory 2017-12-13 18:50:57 -05:00			`1. Go into the root of your GitHub repo directory where you will be creating the docs.`
Bump docusaurus-init to 1.0.2 (#788) 2018-06-19 10:33:24 -04:00			1. `npx docusaurus-init`
Add readme to docusaurus-init directory 2017-12-13 18:50:57 -05:00
Bump docusaurus-init to 1.0.2 (#788) 2018-06-19 10:33:24 -04:00			`> 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).`