Commit graph

12 commits

Author SHA1 Message Date
Yangshun Tay
55e676cb25
misc: add command to run prettier on docs (#2102)
* misc: add command to run prettier on docs

* Fix GH issue template

* Fix tests

* Add prettier-docs command to precommit
2019-12-07 21:56:30 -08:00
Jay Martin
8483012f36 docs: refer to Terminal and Git Bash (#1737)
I think the tutorial should tell Windows users to use Git Bash. Later in the tutorial is a command that worked in Git Bash, `publish-gh-pages`, but didn't work for me at the Windows command prompt.
2019-08-02 03:12:59 -07:00
Jay Martin
ecc434a7fa docs: change example so USERNAME is only for GitHub (#1721)
I changed the `cd` example so it wouldn't say USERNAME like cloning example, which might mislead a new user.
2019-07-28 22:13:25 -07:00
Jay Martin
9da4cc9640 move "cd to the repository" to "Scaffold the Site" (#1713)
The folder isn't important for the command `npm install --global docusaurus-init`. 

However, it is important to run `docusaurus-init` in the repository folder. The pull request moves the step to **[Scaffold the Site](https://docusaurus.io/docs/en/next/tutorial-create-new-site#scaffold-the-site).**
2019-07-27 09:54:33 +08:00
Jay Martin
a867503f20 docs: rearrange the info for install and check Node.js (#1712)
The description of `npm` fits better in the opening paragraph than in a numbered step. The note about version 8 fits better in the Check section than the Install section.
2019-07-26 11:07:48 -07:00
Jay Martin
ab7e3589d0 docs: move a cd step to the start of the init task (#1710)
The `cd` step seems like the first step of "Install the Docusaurus init command," instead of the last step of "Create a GitHub repository and local clone."
2019-07-26 00:25:46 -07:00
Jay Martin
59b0f9cbac docs: add a cd step before clone in "Setting Up" (#1707)
* 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
2019-07-25 13:27:01 -07:00
Jay Martin
c6b7c94367 docs: add "Install Git" to the "Setting Up" page (#1705)
* Add "Install Git" as a prerequisite

* Update tutorial-setup.md
2019-07-25 13:21:57 -07:00
TurekBot
cb7c6f34b9 doc: mention HTTPS approach in tutorial git clone step (#1471)
* doc: change tutorial git to suggest HTTPS

Since we're instructing the user to create a new repository, it might be a safe bet to assume that they don't have their SSH keys set up. HTTPS might be a better option in this context.

* docs: keep ssh add https

@Hongarc said, "How about keep `SSH` and add `HTTPS`." This is one way to do that.

* Update tutorial-setup.md
2019-05-16 19:20:27 -07:00
Yangshun Tay
2fe73edc22
docs: add versioning to tutorial (#1413)
* docs: add versioning to tutorial

* docs: address Endilie's comments
2019-04-29 09:51:42 -07:00
Yangshun Tay
16fe5196cb fix: use class names for tutorial images 2019-04-23 11:36:51 -07:00
Yangshun Tay
23e56f61f5
feat: add tutorial (#1381)
* feat: add tutorial

* feat: complete tutorial

* Fix link
2019-04-23 09:44:37 -07:00