CODEWITHSUNDEEP
ruby-on-railsrubydocumentation-generationannotateyard
Amin Shah Gilani
Amin Shah Gilani

Reputation: 9866

How do I get `annotate_models` gem to work with yard in markdown?

How do I get annotate_models gem to work with yard in markdown?

At the moment, I specify --markup markdown in .yardopts and use the following in auto_annotate_models.rake:

'format_markdown'         => 'true'

However, the markdown renders very weirdly. Here's how the file looks like:

enter image description here

Upvotes: 1

Views: 229

Answers (1)

Amin Shah Gilani
Amin Shah Gilani

Reputation: 9866

Annotate generates markdown compatible with kramdown, hence specifying --markup markdown --markup-provider kramdown in .yardopts fixes this.

Here's the fixed render:

enter image description here

Upvotes: 1

Related Questions