feat(v1): allow specifying meta desc in front matter #1859
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yangshun
force-pushed
the
yangshun/meta-desc
branch
from
233dece
to
c7c88ac
Compare
|
Deploy preview for docusaurus-2 ready! Built with commit 233dece |
|
Deploy preview for docusaurus-preview ready! Built with commit 233dece |
|
Deploy preview for docusaurus-2 ready! Built with commit 85bcf44 |
|
Deploy preview for docusaurus-preview ready! Built with commit 85bcf44 |
yangshun
force-pushed
the
yangshun/meta-desc
branch
from
c7c88ac
to
b60efb8
Compare
endiliey
approved these changes
Oct 20, 2019
endiliey
reviewed
Oct 20, 2019
docs/api-doc-markdown.md
Outdated
| @@ -15,6 +15,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`. | |||
|
|
|||
| `description`: The description of your document which will become the `<meta name="description" content="..."/>` and `<meta property="og:description" content="..."/>` in `<head>`. If this field is not present, it will default to the first line of the contents. | |||
There was a problem hiding this comment.
Maybe should make it similar to v2
endiliey
reviewed
Oct 20, 2019
docs/api-doc-markdown.md
Outdated
| @@ -15,6 +15,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`. | |||
|
|
|||
| `description`: The description of your document which will become the `<meta name="description" content="..."/>` and `<meta property="og:description" content="..."/>` in `<head>`. If this field is not present, it will default to the first line of the contents. | |||
There was a problem hiding this comment.
Suggested change
| `description`: The description of your document which will become the `<meta name="description" content="..."/>` and `<meta property="og:description" content="..."/>` in `<head>`. If this field is not present, it will default to the first line of the contents. | |
| `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 |
There was a problem hiding this comment.
I prefer to keep it explicit
yangshun
force-pushed
the
yangshun/meta-desc
branch
from
b60efb8
to
85bcf44
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
RN docs wanted to be able to explicitly specify the description in the front matter.
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)
Related PRs
NA