Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating step 2 to be more intuitive: "Avoiding use of the word github" #900

Merged
merged 2 commits into from
Aug 13, 2018
Merged

Updating step 2 to be more intuitive: "Avoiding use of the word github" #900

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47870cd
Updating step 2 to be more intuitive
apuravchauhan Aug 11, 2018
e8ee056
Update getting-started-installation.md
JoelMarcey Aug 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/getting-started-installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down