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

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

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

* misc(v2): sync with v1
This commit is contained in:
Yangshun Tay 2019-10-20 11:17:10 -07:00 • committed by GitHub
parent 2c1012b9ec
commit a690d34af0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/api-doc-markdown.md
View file

@ -11,13 +11,11 @@ Docusaurus uses [GitHub Flavored Markdown (GFM)](https://guides.github.com/featu
Documents use the following markdown header fields that are enclosed by a line `---` on either side: 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 its file name (without the extension). - `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`.
`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.
- `description`: The description of your document which will become the `<meta name="description" content="..."/>` and `<meta property="og:description" content="..."/>` in `<head>`, used by search engines. If this field is not present, it will default to the first line of the contents.
`hide_title`: Whether to hide the title at the top of the doc. - `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`.
`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`.
For example: For example:

1
docs/getting-started-installation.md
View file

@ -1,6 +1,7 @@
--- ---
id: installation id: installation
title: 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. Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

2
packages/docusaurus-1.x/lib/core/DocsLayout.js
View file

@ -88,7 +88,7 @@ class DocsLayout extends React.Component {
separateOnPageNav: hasOnPageNav, separateOnPageNav: hasOnPageNav,
})} })}
title={title} title={title}
description={content.trim().split('\n')[0]} description={metadata.description || content.trim().split('\n')[0]}
language={metadata.language} language={metadata.language}
version={metadata.version} version={metadata.version}
metadata={metadata}> metadata={metadata}>

1
packages/docusaurus-1.x/lib/server/readMetadata.js
View file

@ -36,6 +36,7 @@ const SupportedHeaderFields = new Set([
'hide_title', 'hide_title',
'layout', 'layout',
'custom_edit_url', 'custom_edit_url',
'description',
]); ]);
let allSidebars; let allSidebars;

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

@ -101,8 +101,8 @@ Documents use the following markdown header fields that are enclosed by a line `
- `hide_title`: Whether to hide the title at the top of the doc. By default it is `false`. - `hide_title`: Whether to hide the title at the top of the doc. 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`. - `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`. - `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`.
- `description`: Description meta tag for the document page, for search engines. If this field is not present, it will default to the first line of the contents.
- `keywords`: Keywords meta tag for the document page, for search engines. - `keywords`: Keywords meta tag for the document page, for search engines.
- `description`: The description of your document, which will become the `<meta name="description" content="..."/>` and `<meta property="og:description" content="..."/>` in `<head>`, used by search engines. If this field is not present, it will default to the first line of the contents.
- `image`: Cover or thumbnail image that will be used when displaying the link to your post. - `image`: Cover or thumbnail image that will be used when displaying the link to your post.
Example: Example: