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

feat(v2): allow hiding docs table of contents (#2012)

Browse source 
* feat(v2): allow hiding docs table of contents

* move to frontmatter
This commit is contained in:
Yangshun Tay 2019-11-19 00:08:45 -08:00 • committed by Endi
parent 1bf590ea2b
commit edf4c16c93
4 changed files with 12 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
website/docs/markdown-features.mdx
View file

@ -99,6 +99,7 @@ Documents use the following markdown header fields that are enclosed by a line `
- `id`: A unique document id. If this field is not present, the document's `id` will default to its file name (without the extension).
- `title`: The title of your document. If this field is not present, the document's `title` will default to its `id`.
- `hide_title`: Whether to hide the title at the top of the doc. By default it is `false`.
- `hide_table_of_contents`: Whether to hide the table of contents to the right. By default it is `false`.
- `sidebar_label`: The text shown in the document sidebar and in the next/previous button for this document. If this field is not present, the document's `sidebar_label` will default to its `title`.
- `custom_edit_url`: The URL for editing this document. If this field is not present, the document's edit URL will fall back to `editUrl` from options fields passed to `docusaurus-plugin-content-docs`.
- `keywords`: Keywords meta tag for the document page, for search engines.
@ -112,6 +113,7 @@ Example:
id: doc-markdown
title: Markdown Features
hide_title: false
hide_table_of_contents: false
sidebar_label: Markdown :)
custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
description: How do I find you when I cannot solve this problem