feat(v1): allow specifying meta desc in front matter

facebook · Oct 19, 2019 · 233dece · 233dece
1 parent e408d72
commit 233dece
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/docs/getting-started-installation.md b/docs/getting-started-installation.md
@@ -1,6 +1,7 @@
 ---
 id: installation
 title: Installation
+description: Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly!
 ---
 
 Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

diff --git a/packages/docusaurus-1.x/lib/core/DocsLayout.js b/packages/docusaurus-1.x/lib/core/DocsLayout.js
@@ -88,7 +88,7 @@ class DocsLayout extends React.Component {
           separateOnPageNav: hasOnPageNav,
         })}
         title={title}
-        description={content.trim().split('\n')[0]}
+        description={metadata.description || content.trim().split('\n')[0]}
         language={metadata.language}
         version={metadata.version}
         metadata={metadata}>

diff --git a/packages/docusaurus-1.x/lib/server/readMetadata.js b/packages/docusaurus-1.x/lib/server/readMetadata.js
@@ -36,6 +36,7 @@ const SupportedHeaderFields = new Set([
   'hide_title',
   'layout',
   'custom_edit_url',
+  'description',
 ]);
 
 let allSidebars;
@@ -175,7 +176,9 @@ function processMetadata(file, refDir) {
     versionPart = 'next/';
   }
 
-  metadata.permalink = `${docsPart}${langPart}${versionPart}${metadata.id}.html`;
+  metadata.permalink = `${docsPart}${langPart}${versionPart}${
+    metadata.id
+  }.html`;
 
   // change ids previous, next
   metadata.localized_id = metadata.id;