feat(v2): allow hiding docs table of contents

facebook · Nov 19, 2019 · a902648 · a902648
1 parent 1bf590e
commit a902648
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 2 deletions.
diff --git a/packages/docusaurus-plugin-content-docs/src/metadata.ts b/packages/docusaurus-plugin-content-docs/src/metadata.ts
@@ -111,6 +111,11 @@ export default async function processMetadata({
     delete metadata.custom_edit_url;
   }
 
+  if (metadata.hide_table_of_contents) {
+    metadata.hideTableOfContents = Boolean(metadata.hide_table_of_contents);
+    delete metadata.hide_table_of_contents;
+  }
+
   if (showLastUpdateAuthor || showLastUpdateTime) {
     // Use fake data in dev for faster development
     const fileLastUpdateData =

diff --git a/packages/docusaurus-plugin-content-docs/src/types.ts b/packages/docusaurus-plugin-content-docs/src/types.ts
@@ -95,6 +95,7 @@ export interface MetadataRaw extends OrderMetadata {
   lastUpdatedAt?: number;
   lastUpdatedBy?: string;
   hide_title?: boolean;
+  hide_table_of_contents?: boolean;
   [key: string]: any;
 }
 

diff --git a/packages/docusaurus-theme-classic/src/theme/DocItem/index.js b/packages/docusaurus-theme-classic/src/theme/DocItem/index.js
@@ -62,6 +62,7 @@ function DocItem(props) {
     lastUpdatedAt,
     lastUpdatedBy,
     keywords,
+    hideTableOfContents,
   } = metadata;
 
   const metaImageUrl = siteUrl + useBaseUrl(metaImage);
@@ -172,7 +173,9 @@ function DocItem(props) {
                 </div>
               </div>
             </div>
-            {DocContent.rightToc && <DocTOC headings={DocContent.rightToc} />}
+            {!hideTableOfContents && DocContent.rightToc && (
+              <DocTOC headings={DocContent.rightToc} />
+            )}
           </div>
         </div>
       </div>

diff --git a/packages/docusaurus-theme-classic/src/theme/DocItem/styles.module.css b/packages/docusaurus-theme-classic/src/theme/DocItem/styles.module.css
@@ -20,7 +20,6 @@
 .docItemContainer {
   margin: 0 auto;
   padding: 0 0.5rem;
-  max-width: 45em;
 }
 
 .tableOfContents {

diff --git a/website/docs/markdown-features.mdx b/website/docs/markdown-features.mdx
@@ -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