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

Markdown doesn't render in OgDescription (metadata) #1014

Closed
mattkanwisher opened this issue Oct 2, 2018 · 4 comments
Closed

Markdown doesn't render in OgDescription (metadata) #1014

mattkanwisher opened this issue Oct 2, 2018 · 4 comments
Labels
bug An error in the Docusaurus core causing instability or issues with its execution good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. help wanted Asking for outside help and/or contributions to this particular issue or PR. status: claimed Issue has been claimed by a contributor who plans to work on it.

Comments

@mattkanwisher
Copy link

mattkanwisher commented Oct 2, 2018

🐛 Bug Report

(A clear and concise description of what the bug is)

Have you read the Contributing Guidelines on issues?

Yes

To Reproduce

  1. curl https://loomx.io/developers/docs/en/phaser-sdk-demo.html
  2. You can see <meta property="og:description" content="![Game screenshot](/developers/img/screenshot.png)"/>
  3. Source code is here https://github.com/loomnetwork/loom-sdk-documentation

screen shot 2018-10-02 at 3 28 39 pm

Expected behavior

Expected to see the image, or text of the rendered markdown, now the raw markdown text.

Actual Behavior

Og:Description has markdown in it

<meta property="og:description" content="![Game screenshot](/developers/img/screenshot.png)"/>

screen shot 2018-10-02 at 3 28 39 pm

Reproducible Demo

https://loomx.io/developers/docs/en/phaser-sdk-demo.html

We are on Docasuarus hash(a6db22b) but I tested with "1.4.0", and source to repo is here https://github.com/loomnetwork/loom-sdk-documentation

Seems like i18n broke on upgrade ;( so I can't upgrade to 1.4.0 immediately without breaking out side for non English speakers, but problem does exist on newest build of docasaurus

@endiliey
Copy link
Contributor

In 1.4.0 its just that the i18n format is slightly changed due to some conflicting string. #917

If you are using crowdin, after crowdin-upload ~> some of the strings need to be retranslated.

As for markdown doesnt render correctly, its indeed a bug. Accepting PR on that 😆.

We should render the markdown and not the literal markdown string here
https://github.com/facebook/Docusaurus/blob/127500532103ee9096de9f202866546969ea107d/v1/lib/core/DocsLayout.js#L74

@endiliey endiliey added bug An error in the Docusaurus core causing instability or issues with its execution help wanted Asking for outside help and/or contributions to this particular issue or PR. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. labels Oct 13, 2018
@sebqq
Copy link
Contributor

sebqq commented Oct 17, 2018

Is this issue free? I would like to look at it.

@yangshun yangshun added the status: claimed Issue has been claimed by a contributor who plans to work on it. label Oct 17, 2018
@yangshun
Copy link
Contributor

@sinodko it's yours!

I've added an "issue: claimed" label so that others will know not to start work on the issue. If you change your mind about the issue, no worries! Just let me know so that I can remove the label and free it up for someone else to claim.

I'll check in with you periodically so that we can keep the task updated with the progress.

@sebqq
Copy link
Contributor

sebqq commented Oct 19, 2018

As for markdown doesnt render correctly, its indeed a bug. Accepting PR on that 😆.

We should render the markdown and not the literal markdown string here

Hello @endiliey, If I've understood you correctly, raw HTML should be rendered here instead of markdown text because ogp can contains only a string. Am I right? Thanks :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug An error in the Docusaurus core causing instability or issues with its execution good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. help wanted Asking for outside help and/or contributions to this particular issue or PR. status: claimed Issue has been claimed by a contributor who plans to work on it.
Projects
None yet
Development

No branches or pull requests

4 participants