3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-14 16:52:39 +02:00
Code Issues Projects Releases Packages Wiki Activity

fix(v2): keywords frontmatter should work properly (#1840)

Browse source 
* fix(v2): keywords frontmatter should work properly

* nits

* nits again
This commit is contained in:
Endi 2019-10-15 10:57:08 +07:00 • committed by GitHub
parent bdb129252c
commit c630e1aab9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 19 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG-2.x.md
View file

@ -2,6 +2,7 @@
## 2.0.0-alpha.28 ## 2.0.0-alpha.28
- Further reduce memory usage to avoid heap memory allocation failure. - Further reduce memory usage to avoid heap memory allocation failure.
- Fix `keywords` frontmatter for SEO not working properly.
## 2.0.0-alpha.27 ## 2.0.0-alpha.27

4
packages/docusaurus-theme-classic/src/theme/DocItem/index.js
View file

@ -42,6 +42,7 @@ function DocItem(props) {
editUrl, editUrl,
lastUpdatedAt, lastUpdatedAt,
lastUpdatedBy, lastUpdatedBy,
keywords,
} = metadata; } = metadata;
return ( return (
@ -68,6 +69,9 @@ function DocItem(props) {
<meta name="twitter:image:alt" content={`Image for ${title}`} /> <meta name="twitter:image:alt" content={`Image for ${title}`} />
)} )}
{permalink && <meta property="og:url" content={siteUrl + permalink} />} {permalink && <meta property="og:url" content={siteUrl + permalink} />}
{keywords && keywords.length && (
<meta property="keywords" content={keywords.join(',')} />
)}
</Head> </Head>
<div className="padding-vert--lg"> <div className="padding-vert--lg">
<div className="container"> <div className="container">

2
packages/docusaurus-theme-classic/src/theme/Layout/index.js
View file

@ -48,7 +48,7 @@ function Layout(props) {
<meta property="og:description" content={description} /> <meta property="og:description" content={description} />
)} )}
{keywords && keywords.length && ( {keywords && keywords.length && (
<meta property="keywords" content={keywords} /> <meta property="keywords" content={keywords.join(',')} />
)} )}
{metaImage && ( {metaImage && (
<meta <meta

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

@ -101,6 +101,9 @@ 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 of this document page.
- `image`: Cover or thumbnail image that will be used when displaying the link to your post.
- `keywords`: Keywords for search engines.
Example: Example:
@ -110,6 +113,11 @@ id: doc-markdown
title: Markdown Features title: Markdown Features
sidebar_label: Markdown :) sidebar_label: Markdown :)
custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
keywords:
- docs
- docusaurus
description: How do I find you when I cannot solve this problem
image: https://i.imgur.com/mErPwqL.png
--- ---
``` ```

2
website/docs/migrating-from-v1-to-v2.md
View file

@ -32,7 +32,7 @@ This provides a clear distinction between Docusaurus' official packages and comm
Meanwhile, the default doc site functionalities provided by Docusaurus 1 are now provided by `@docusaurus/preset-classic`. Therefore, we need to add this dependency as well: Meanwhile, the default doc site functionalities provided by Docusaurus 1 are now provided by `@docusaurus/preset-classic`. Therefore, we need to add this dependency as well:
```diff ```json
// package.json // package.json
{ {
dependencies: { dependencies: {

8
website/docs/seo.md
View file

@ -39,7 +39,7 @@ module.exports = {
}; };
``` ```
## Page specific SEO ## Document Page specific SEO
To add SEO to your doc, use the following fields in your doc's front matter: To add SEO to your doc, use the following fields in your doc's front matter:
@ -80,15 +80,15 @@ Note that the file of this image cannot be SVG.
To add customized SEO, use the `Head` component from `@docusaurus/Head`. To add customized SEO, use the `Head` component from `@docusaurus/Head`.
Example:
```js ```js
import Head from '@docusaurus/Head'; import Head from '@docusaurus/Head';
const MySEO = () => ( const MySEO = () => (
<> <>
<Head> <Head>
<meta charSet="utf-8" /> <meta property="og:description" content={'My custom description'} />
<meta httpEquiv="x-ua-compatible" content="ie=edge" />
<meta name="viewport" content="width=device-width" />
</Head> </Head>
</> </>
); );