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 redcarpet gem to enable GFM syntax #11

Merged
merged 1 commit into from
Jan 24, 2025
Merged

Conversation

skatkov
Copy link

@skatkov skatkov commented Jan 24, 2025

YARD uses Github Flavored Markdown by default if you have redcarpet gem present.

Due to the growing popularity of Github-Flavoured-Markdown (GFM), YARD now uses the Redcarpet library as the default Markdown formatting library with GFM fenced code blocks enabled. This means that you can use fenced code blocks inside of Markdown files with redcarpet installed without any extra code. Previously, users who wanted GFM in their Markdown would have to specify -m markdown -M redcarpet, but this is now the default behaviour for YARD.

From here https://rubydoc.info/gems/yard/file/docs/WhatsNew.md#What_s_New_in_0_7_x

@julik
Copy link
Contributor

julik commented Jan 24, 2025

Sweet! Let's place it in the gemspec along with other development deps and comment what it is for, and it's good to go!

@skatkov
Copy link
Author

skatkov commented Jan 24, 2025

@julik 👍

@julik julik self-requested a review January 24, 2025 23:47
@julik julik merged commit e7bc7ef into stepper-motor:main Jan 24, 2025
@skatkov skatkov deleted the gfm branch January 25, 2025 12:36
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.

2 participants