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

Replace markdown parser from Greenmat to Qiita Marker #130

Closed
kyntk opened this issue Nov 15, 2022 · 0 comments · Fixed by #131
Closed

Replace markdown parser from Greenmat to Qiita Marker #130

kyntk opened this issue Nov 15, 2022 · 0 comments · Fixed by #131

Comments

@kyntk
Copy link
Contributor

kyntk commented Nov 15, 2022

Currently, Qiita Markdown uses Greenmat, an extension of Redcarpet, to parse Markdown.
On February 21st, 2022, we changed the Markdown parser used in Qiita to Qiita Marker, an extension of CommonMarker.

Accordingly, this gem also changes its Markdown parser from Greenmat to Qiita Marker.

Please see the following page for details about changes on Qiita.
https://blog.qiita.com/replace-markdown-parser-general/

Effects of the Markdown parser change on rendering results

The basic parsing results will remain the same, however some notations will be changed and rendering results may change.

After the change, it will be GitHub Fravored Markdown Spec compliant.
https://github.github.com/gfm/

The following is a list of some of the relatively commonly used ones in Qiita.

Headings: Need at least one space after #

Bad

##Headings previously used

Good

## Having at least one space after marker

HTML blocks: Need at least one blank line after HTML block

<details><summary>Summary</summary>

## Need at least one blank line before following markdown

Paragraph.
</details>

Also need it above this line, too.

Emphasis and strong emphasis

Content to be emphasized may vary depending on the presence or absence of spaces before and after the word to be emphasized.
Put a space before and after, e.g., "plain text **text to be emphasized** plain text".

The others

Please see the following page for details.
https://help.qiita.com/ja/articles/qiita-markdown#markdown

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

Successfully merging a pull request may close this issue.

1 participant