3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-01 11:18:24 +02:00
Code Issues Projects Releases Packages Wiki Activity

doc: remove references to F8 in tutorial (#1432)

Browse source 
* doc: remove references to F8 in tutorial

* misc: use correct bold syntax

* misc: fix path
This commit is contained in:
Yangshun Tay 2019-05-02 19:16:05 -07:00 • committed by GitHub
parent 64fdafbcea
commit c84860d9fa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
docs/tutorial-create-pages.md
View file

@ -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. 2. Go to http://localhost:3000/hello-world and you should be able to see the new page.
1. Change the text within the `<p>...</p>` to "I'm at F8!". The browser should refresh automatically to reflect the changes. 1. Change the text within the `<p>...</p>` to "I can write JSX here!". The browser should refresh automatically to reflect the changes.
```diff ```diff
- <p>This is my first page!</p> - <p>This is my first page!</p>
+ <p>I'm at F8!</p> + <p>I can write JSX here!</p>
``` ```
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). 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 ## 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: 1. Paste the following contents:
``` ```
--- ---
id: f8 id: doc4
title: Hello F8 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 ```diff
{ {
"docs": { "docs": {
"Docusaurus": [ "Docusaurus": [
"doc1", "doc1",
+ "f8" + "doc4"
], ],
"First Category": ["doc2"], "First Category": ["doc2"],
"Second Category": ["doc3"] "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 (<kbd>Cmd</kbd> + <kbd>C</kbd> or <kbd>Ctrl</kbd> + <kbd>C</kbd>) and restart it (with `npm run start`) because a server restart is needed for sidebar changes. 4. Kill your webserver (<kbd>Cmd</kbd> + <kbd>C</kbd> or <kbd>Ctrl</kbd> + <kbd>C</kbd>) 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. 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.