3.8 KiB
| id | title |
|---|---|
| doc-markdown | Markdown Features |
Markdown Headers
Documents
Documents use the following markdown header fields that are enclosed by a line --- on either side:
id: A unique document id. If this field is not present, the document's id will default to it's file name (without the extension).
title: The title of your document. If this field is not present, the document's title will default to it's id.
sidebar_label: The text shown in the document sidebar for this document. If this field is not present, the document's sidebar_label will default to it's title.
For example:
---
id: doc1
title: My Document
sidebar_label: Document
---
Versioned documents have their ids altered to include the version number when they get copied. The new id is version-${version}-${id} where ${version} is the version number of that document and ${id} is the original id. Additionally, versioned documents get an added original_id field with the original document id.
For example:
---
id: version-1.0.0-doc1
title: My Document
sidebar_label: Document
original_id: doc1
---
Blog Posts
Blog Posts use the following markdown header fields that are enclosed by a line --- on either side:
title: The title of this blog post.
author: The author of this blog post. If this field is omitted, no author name will be shown.
authorURL: A page to link to when a site user clicks the author's name. If this field is omitted, the author's name will not link to anything.
authorFBID: The author's Facebook id, used only to get the author's profile picture to display with the blog post. If this field is omitted, no author picture will be shown for the blog post.
For example:
---
title: My First Blog Post
author: Frank Li
authorURL: http://twitter.com/franchementli
authorFBID: 100002976521003
---
Extra Features
Docusaurus supports some extra features when writing documentation in markdown.
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.
Example:
[This links to another document](other-document.md)
This markdown will automatically get converted into a link to /docs/other-document.html (or the appropriately translated/versioned link) once it gets rendered.
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
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.
Example:
Generating Table of Contents
You can make an autogenerated list of links, which can be useful as a table of contents for API docs.
In your markdown file, insert a line with the text <AUTOGENERATED_TABLE_OF_CONTENTS>. Write your documentation using h3 headers for each function inside a code block. These will be found by Docusaurus and a list of links to these sections will inserted at the text <AUTOGENERATED_TABLE_OF_CONTENTS>.
Example:
### `docusaurus.function(a, b)`
Text describing my function
### `docdoc(file)`
Text describing my function
will lead to a table of contents of the functions:
- `docusaurus.function(a, b)`
- `docdoc(file)`
and each function will link to their corresponding sections in the page.