lsegal / yard

YARD is a Ruby Documentation tool. The Y stands for "Yay!"

http://yardoc.org

MIT License

1.95k stars 398 forks source link

enable table support for CommonMarker #1443

Closed notEthan closed 2 years ago

notEthan commented 2 years ago

Description

In switching from redcarpet to commonmarker, I found pipe-delimited tables did not render. commonmarker supports these and enabling them is a matter of merely adding :table to the extensions parameter of CommonMarker.render_html, and enabling existing tests for this markdown provider.

this was enabled by default for redcarpet long ago in https://github.com/lsegal/yard/pull/765 and I think it is good to do for commonmarker too.

Completed Tasks

[x] I have read the Contributing Guide.
[x] The pull request is complete (implemented / written).
[x] Git commits have been cleaned up (squash WIP / revert commits).
[x] I wrote tests and ran bundle exec rake locally (if code is attached to PR). (sort of, I just turned on existing tests)

lsegal commented 2 years ago

Thanks for this quick fix!