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

Escaping pipes in the code of table elements #5864

Merged
merged 1 commit into from
Dec 5, 2022

Conversation

dearblue
Copy link
Contributor

@dearblue dearblue commented Dec 3, 2022

ref. https://github.github.com/gfm/#example-200


The "yard" called by "mrbdoc" has several libraries available to parse Markdown.
Note: The preferred library can be changed with mrbdoc -M <gem-name>.

https://github.com/lsegal/yard/blob/v0.9.28/lib/yard/templates/helpers/markup_helper.rb#L24-L34
https://github.com/lsegal/yard/blob/v0.9.28/lib/yard/templates/helpers/markup_helper.rb#L87-L116

Ruby gem name Support table? Can pipes in codes inside tables be escapable? Note
redcarpet yes no
rdiscount yes yes
kramdown yes yes, but escaped characters remain
bluecloth no
maruku yes no HTML tags are not allowed in Markdown
rpeg-markdown ? ? require "rpeg-markdown" fails; archived repository
rdoc no Maybe support in the next rdoc? ruby/rdoc#931
commonmarker no Maybe support in the next yard? lsegal/yard#1443

In "doxygen", the | directive in mrb_get_args() in include/mruby.h is fine, but in opcode.md the escaping for pipe remains.

@dearblue dearblue requested a review from matz as a code owner December 3, 2022 06:10
@matz matz merged commit d4fb67a into mruby:master Dec 5, 2022
@dearblue dearblue deleted the doc/escape-pipe branch December 25, 2022 12:29
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 this pull request may close these issues.

None yet

2 participants