Add hide_title metadata that hides the title text on the top of the d…

…oc (#540)
facebook · Apr 12, 2018 · 6dd6ead · 6dd6ead
1 parent ad5b8b9
commit 6dd6ead
Show file tree

Hide file tree

Showing 4 changed files with 3,842 additions and 16 deletions.
diff --git a/docs/api-doc-markdown.md b/docs/api-doc-markdown.md
@@ -13,6 +13,8 @@ Documents use the following markdown header fields that are enclosed by a line `
 
 `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.
+
 `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 its `title`.
 
 For example:

diff --git a/lib/core/Doc.js b/lib/core/Doc.js
@@ -60,11 +60,12 @@ class Doc extends React.Component {
         </a>
       );
     }
+
     return (
       <div className="post">
         <header className="postHeader">
           {editLink}
-          <h1>{this.props.title}</h1>
+          {!this.props.hideTitle && <h1>{this.props.title}</h1>}
         </header>
         <article>
           <MarkdownBlock>{this.props.content}</MarkdownBlock>

diff --git a/lib/core/DocsLayout.js b/lib/core/DocsLayout.js
@@ -23,17 +23,16 @@ class DocsLayout extends React.Component {
     if (this.props.Doc) {
       DocComponent = this.props.Doc;
     }
+    const title = i18n
+      ? translation[this.props.metadata.language]['localized-strings'][
+          this.props.metadata.localized_id
+        ] || this.props.metadata.title
+      : this.props.metadata.title;
     return (
       <Site
         config={this.props.config}
         className="sideNavVisible doc"
-        title={
-          i18n
-            ? translation[this.props.metadata.language]['localized-strings'][
-                this.props.metadata.localized_id
-              ] || this.props.metadata.title
-            : this.props.metadata.title
-        }
+        title={title}
         description={content.trim().split('\n')[0]}
         language={metadata.language}
         version={metadata.version}
@@ -46,14 +45,8 @@ class DocsLayout extends React.Component {
               content={content}
               config={this.props.config}
               source={metadata.source}
-              title={
-                i18n
-                  ? translation[this.props.metadata.language][
-                      'localized-strings'
-                    ][this.props.metadata.localized_id] ||
-                    this.props.metadata.title
-                  : this.props.metadata.title
-              }
+              hideTitle={this.props.metadata.hide_title}
+              title={title}
               version={metadata.version}
               language={metadata.language}
             />