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.

Sign up for GitHub

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

Jump to bottom

Commonmarker 1.0 support #1528

Open
haines opened this issue Jan 12, 2024 · 1 comment · May be fixed by #1540
Open

Commonmarker 1.0 support #1528

haines opened this issue Jan 12, 2024 · 1 comment · May be fixed by #1540

Comments

@haines
Copy link

haines commented Jan 12, 2024 •
edited

Commonmarker 1.0 changes the top-level constant name from CommonMarker to Commonmarker, so YARD fails to detect the provider.

yard/lib/yard/templates/helpers/markup_helper.rb

Line 33 in 2d197a3

{:lib => :commonmarker, :const => 'CommonMarker'}

gjtorikian/commonmarker#269

The method used to render markdown is now Commonmarker.to_html rather than CommonMarker.render_html. It takes a hash of options instead of the previous arrays of symbols.

yard/lib/yard/templates/helpers/html_helper.rb

Line 93 in 2d197a3

CommonMarker.render_html(text, %i[DEFAULT GITHUB_PRE_LANG], %i[autolink table])

ParadoxV5 added a commit to ParadoxV5/Godot.rb that referenced this issue Feb 23, 2024
@ParadoxV5
Roll commonmarker back to 0.x
0994046 
lsegal/yard#1528
ParadoxV5 added a commit to ParadoxV5/template-ruby-gem that referenced this issue Feb 23, 2024
@ParadoxV5
Rollback commonmarker 0.x & Update CI paths
849107d 
* ParadoxV5/Godot.rb@0994046
  * lsegal/yard#1528
* ParadoxV5/Godot.rb@b2705ef
ParadoxV5 added a commit to ParadoxV5/yard that referenced this issue Mar 23, 2024
@ParadoxV5 @haines
Support Commonmarker (lowercase m) from v1.x
3472342 
Fixes lsegal#1528

Co-Authored-By: Andrew Haines <andrew@haines.org.nz>
@ParadoxV5 ParadoxV5 linked a pull request Mar 23, 2024 that will close this issue
Open
4 tasks
@ParadoxV5
Copy link

For those who can’t wait for the maintainer to read my PR, you can use this in your Gemfile:

gem 'yard', github: 'ParadoxV5/yard', tag: 'commonmarker-1.0_1'

or, to use the branch’s bleeding edge that the PR may revise:

gem 'yard', github: 'ParadoxV5/yard', branch: 'commonmarker-1.0'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Commonmarker 1.0 support ParadoxV5/yard
2 participants
@haines @ParadoxV5