From c84860d9fa872d519f6dda27bc48ebb546e7aa82 Mon Sep 17 00:00:00 2001 From: Yangshun Tay Date: Thu, 2 May 2019 19:16:05 -0700 Subject: [PATCH] doc: remove references to F8 in tutorial (#1432) * doc: remove references to F8 in tutorial * misc: use correct bold syntax * misc: fix path --- docs/tutorial-create-pages.md | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/docs/tutorial-create-pages.md b/docs/tutorial-create-pages.md index 30c0e1a976..5df6ab0b4c 100644 --- a/docs/tutorial-create-pages.md +++ b/docs/tutorial-create-pages.md @@ -34,11 +34,11 @@ module.exports = HelloWorld; ``` 2. Go to http://localhost:3000/hello-world and you should be able to see the new page. -1. Change the text within the `

...

` to "I'm at F8!". The browser should refresh automatically to reflect the changes. +1. Change the text within the `

...

` to "I can write JSX here!". The browser should refresh automatically to reflect the changes. ```diff -

This is my first page!

-+

I'm at F8!

++

I can write JSX here!

``` React is being used as a templating engine for rendering static markup. You can leverage on the expressability of React to build rich web content. Learn more about creating pages [here](custom-pages). @@ -47,30 +47,37 @@ React is being used as a templating engine for rendering static markup. You can ## Create a Documentation Page -1. Create a new file in the `docs` folder called `f8.md`. +1. Create a new file in the `docs` folder called `doc4.md`. 1. Paste the following contents: ``` --- -id: f8 -title: Hello F8 +id: doc4 +title: This is Doc 4 --- -Hello F8! I'm at the Docusaurus classroom session! +I can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/). -## Using Docusaurus to Create Open Source Websites +## Markdown Syntax -In this session, we learned how Docusaurus makes it really simple to create a website for open source project documentation and get hands on by creating a Docusaurus website. +**Bold** _italic_ `code` [Links](#url) + +> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse +> id sem consectetuer libero luctus adipiscing. + +* Hey +* Ho +* Let's Go ``` -3. Go to `sidebars.json` and add `"f8"` after `"doc1"`. This ID should be the same one as in the Markdown file above. +3. Go to `sidebars.json` and add `"doc4"` after `"doc1"`. This ID should be the same one as in the Markdown file above. ```diff { "docs": { "Docusaurus": [ "doc1", -+ "f8" ++ "doc4" ], "First Category": ["doc2"], "Second Category": ["doc3"] @@ -82,7 +89,7 @@ In this session, we learned how Docusaurus makes it really simple to create a we ``` 4. Kill your webserver (Cmd + C or Ctrl + C) and restart it (with `npm run start`) because a server restart is needed for sidebar changes. -5. Navigate to http://localhost:3000/docs/f8. +5. Navigate to http://localhost:3000/docs/doc4. You've created your first documentation page on Docusaurus! The `sidebars.json` is where you specify the order of your documentation pages and in the front matter of the Markdown file is where you provide metadata about that page.