Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: render proper HTML instead of raw markdown in meta description #1054

Merged

Conversation

sebqq
Copy link
Contributor

@sebqq sebqq commented Oct 22, 2018

Motivation

A pure markdown text was previously shown in "og:description" and "description" meta tags in Docs. Markdown text should be rendered into the HTML instead. Fixes #1014

Have you read the Contributing Guidelines on pull requests?

yes

Test Plan

  1. Create any doc page and start the application to render changes.
  2. Open a dev tools in your browser and look for tags in head of your doc page.

Test by Open Graph Check:

og:description before changes:

before

og:description after changes:

after

You should see that content of description is rendered into the raw HTML in <meta name"description" > and <meta property="og:description" > tags.

@sebqq sebqq changed the title Origin/docslayout ogdesc render markdown Docs render markdown text to the raw HTML in meta description Oct 22, 2018
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Oct 22, 2018
@docusaurus-bot
Copy link
Contributor

Deploy preview for docusaurus-preview ready!

Built with commit 330dd42

https://deploy-preview-1054--docusaurus-preview.netlify.com

Copy link
Contributor

@endiliey endiliey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you use https://opengraphcheck.com and test it with a small test case (before) and (after) result. Post the results as your test plan so we are certain it works

@sebqq
Copy link
Contributor Author

sebqq commented Oct 23, 2018

Thanks @endiliey! I've just added pictures from Open Graph Check to my Test plan.

@endiliey endiliey changed the title Docs render markdown text to the raw HTML in meta description fix: render markdown text to the raw HTML in meta description Oct 24, 2018
@endiliey endiliey changed the title fix: render markdown text to the raw HTML in meta description fix: render proper HTML instead of raw markdown in meta description Oct 24, 2018
Copy link
Contributor

@endiliey endiliey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @sinodko for the contribution ☺

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants