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

Add CommonMarker markdown provider #1388

Merged
merged 1 commit into from
Sep 3, 2021

Conversation

ojab
Copy link
Contributor

@ojab ojab commented Jun 13, 2021

Fixes #1157

Description

Add CommonMarker as a markdown provider. Slower than redcarpet, but has an actual standard.

ojab [ ~/src/yard ]$ time bundle exec ./bin/yard --markup markdown --markup-provider redcarpet
…
real	0m15,173s
user	0m13,997s
sys	0m0,578s
ojab [ ~/src/yard ]$ time bundle exec ./bin/yard --markup markdown --markup-provider commonmarker
…
real	0m16,851s
user	0m15,851s
sys	0m0,493s

OTOH on some big work project difference is insignificant:

$ time bundle exec yard  --markup markdown --markup-provider redcarpet
…
real	10m0,707s
user	9m17,975s
sys	0m17,672s
$ time bundle exec yard --markup markdown --markup-provider commonmarker
…
real	10m6,785s
user	9m25,962s
sys	0m17,463s

Completed Tasks

  • I have read the Contributing Guide.
  • The pull request is complete (implemented / written).
  • Git commits have been cleaned up (squash WIP / revert commits).
  • I wrote tests and ran bundle exec rake locally (if code is attached to PR).

@ojab ojab marked this pull request as ready for review June 13, 2021 16:58
@ojab
Copy link
Contributor Author

ojab commented Jun 13, 2021

Marking as ready for review because of First-time contributors need a maintainer to approve running workflows. Learn more..
bundler exec rake passes locally.

@coveralls
Copy link

coveralls commented Jun 13, 2021

Coverage Status

Coverage increased (+0.005%) to 93.419% when pulling 7b7a7d3 on ojab:add_commonmarker_provider into cfa62ae on lsegal:main.

@ojab ojab force-pushed the add_commonmarker_provider branch from 7030d21 to 7b7a7d3 Compare June 13, 2021 17:06
@ojab
Copy link
Contributor Author

ojab commented Jun 13, 2021

Ok, CI is green after restricting commonmarker to ruby >= 2.3.

Copy link
Owner

@lsegal lsegal left a comment

Choose a reason for hiding this comment

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

Great add, thanks!

@lsegal lsegal merged commit 61b471b into lsegal:main Sep 3, 2021
@ojab ojab deleted the add_commonmarker_provider branch September 3, 2021 20:42
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.

Support CommonMark via commonmarker markup provider
3 participants