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 for Markdown support. #612

Merged
merged 2 commits into from
Apr 29, 2024

Conversation

reitermarkus
Copy link
Member

@reitermarkus reitermarkus commented Apr 27, 2024

We use --markup markdown but don't have redcarpet specified as a dependency, meaning docs are not actually being generated using Markdown, or at least not Github Flavored Markdown.

@dduugg
Copy link
Member

dduugg commented Apr 28, 2024

Did you test this? I think you'll need --markup-provider=redcarpet, in https://github.com/Homebrew/brew/blob/master/Library/Homebrew/.yardopts well, no?

Gemfile Outdated Show resolved Hide resolved
@reitermarkus
Copy link
Member Author

According to https://github.com/lsegal/yard/blob/e833aac7a01510245dd4ae1d1d18b046c8293c2d/docs/WhatsNew.md?plain=1#L542-L547, simply adding it to the Gemfile is enough as it is now the default behaviour for --markup markdown. Also tested this locally.

@Bo98
Copy link
Member

Bo98 commented Apr 28, 2024

Do you have an example page so we can compare the effect this has before & after merge?

@reitermarkus
Copy link
Member Author

It doesn't have any effect in the current docs, because they mostly use <pre> instead of Markdown ```.

@MikeMcQuaid
Copy link
Member

Makes sense, thanks @reitermarkus!

@MikeMcQuaid MikeMcQuaid merged commit 13f1dba into Homebrew:master Apr 29, 2024
1 check passed
@reitermarkus reitermarkus deleted the patch-1 branch April 29, 2024 19:58
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants