Update Markdown Features doc style

This commit is contained in:
Frank Li 2017-08-14 16:27:52 -07:00 committed by GitHub
parent 2f03158fd9
commit 0f618eff9f

View file

@ -5,7 +5,7 @@ title: Markdown Features
## Markdown Headers
### Documents
## Documents
Documents use the following markdown header fields that are enclosed by a line `---` on either side:
@ -38,7 +38,7 @@ original_id: doc1
---
```
### Blog Posts
## Blog Posts
Blog Posts use the following markdown header fields that are enclosed by a line `---` on either side:
@ -65,7 +65,7 @@ authorFBID: 100002976521003
Docusaurus supports some extra features when writing documentation in markdown.
### Linking other Documents
## Linking other Documents
You can use relative urls to other documentation files which will automatically get converted to the corresponding html links when they get rendered.
@ -77,7 +77,7 @@ This markdown will automatically get converted into a link to `/docs/other-docum
This can help when you want to navigate through docs on GitHub since the links there will be functional links to other documents (still on GitHub), but the documents will have the correct html links when they get rendered.
### Linking to Images and Other Assets
## Linking to Images and Other Assets
Static assets can be linked to in the same way that documents are, using relative urls. Static assets used in documents and blogs should go into `docs/assets` and `website/blog/assets`, respectively. The markdown will get converted into correct link paths so that these paths will work for documents of all languages and versions.
@ -87,7 +87,7 @@ Example:
```
### Generating Table of Contents
## Generating Table of Contents
You can make an autogenerated list of links, which can be useful as a table of contents for API docs.