3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-24 20:17:50 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update getting started page to be more intuitive (#900)

Browse source 
* Updating step 2 to be more intuitive

Use of word Github is very confusing. When starting, most of devs wont have an existing github repo. And normally not everyone will be using Github. Since devs will be following this step by step: we need to stress on telling them to create a new or use existing local project folder which may or may not be a github repo.

* Update getting-started-installation.md
This commit is contained in:
Apurav Chauhan 2018-08-13 13:59:45 +05:30 • committed by Yangshun Tay
parent 5e5488f1ea
commit acd4f3f984
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/getting-started-installation.md
View file

@ -13,12 +13,14 @@ We have created an easy script that will get all of the infrastructure set up fo
> You have to be on Node >= 8.x and Yarn >= 1.5.
1. Change directory to the root of your project's GitHub repo.
1. Create a project, if none exists, and change your the directory to this project's root.
You will be creating the docs in this directory. The root directory may
contain other files. The Docusaurus installation script will create two new
directories: `docs-examples-from-docusaurus` and `website`.
> Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus.
1. Run the Docusaurus installation script: `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`.