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

docs: add a cd step before clone in "Setting Up" (#1707)

Browse source 
* Add a cd step before clone in "Setting Up"

Add a `cd` step before clone in **[Setting Up](https://docusaurus.io/docs/en/next/tutorial-setup)**, add examples of `cd` in steps 5 and 7, and edit other steps.

* Update tutorial-setup.md
This commit is contained in:
Jay Martin 2019-07-25 13:27:01 -07:00 • committed by Yangshun Tay
parent c6b7c94367
commit 59b0f9cbac
1 changed files with 19 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

26
docs/tutorial-setup.md
View file

@ -43,20 +43,28 @@ v8.15.1
## Install Yarn (Optional)
We highly recommend you to install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out [here](https://yarnpkg.com/en/docs/install).
We highly recommend that you install Yarn, an alternative package manager that has superb performance for managing your NPM dependencies. Check it out [here](https://yarnpkg.com/en/docs/install).
> You can still proceed with the tutorial without Yarn.
## Create a GitHub Repository
## Create a GitHub repository and local clone
1. Go to https://github.com/ and sign up for an account if you don't already have one.
1. Click on **"New Repository"** or go to https://github.com/new.
1. Name your repository without spaces. For e.g. `docusaurus-tutorial`.
1. Proceed to create the repository without adding `.gitignore` or a license.
1. Click on the green **New** button or go to https://github.com/new.
1. Type a repository name without spaces. For example, `docusaurus-tutorial`.
1. Click **Create repository** (without `.gitignore` and without a license).
<img alt="GitHub create repo" src="/img/tutorial-git-clone.png" class="docImage"/>
5. Clone your repository to your local machine:
5. In your terminal, `cd` to a directory where the local clone will be a subdirectory. (For help see [Introduction to the command-line interface](https://tutorial.djangogirls.org/en/intro_to_command_line/).)
```sh
cd /Users/USERNAME/doc_projects # macOS example
# or
cd /c/USERNAME/doc_projects # Windows example
```
6. Clone your repository to your local machine:
```sh
git clone git@github.com:USERNAME/docusaurus-tutorial.git # SSH
@ -64,7 +72,11 @@ git clone git@github.com:USERNAME/docusaurus-tutorial.git # SSH
git clone https://github.com/USERNAME/docusaurus-tutorial.git # HTTPS
```
6. `cd` into the repository which you just created.
7. `cd` to the directory for the local clone.
```sh
cd docusaurus-tutorial
```
## Install the Docusaurus init command