How to use Markdown at Rubydoc.info?

f.schuindtcs's Avatar

f.schuindtcs

27 Apr, 2017 02:23 AM

Hello folks,

I am developing a Ruby gem and using YARD to document it. When I release a new version, Rubydoc.info automatically starts to parse the new docs. The problem is that it's not processing my documentation markdown correctly.

What I have in my local YARD server

Screen Shot 2017-04-26 at 23.12.57.png

In Rubydoc.info here

Screen Shot 2017-04-26 at 23.13.15.png

I have set in my .yardopts file:

--markup-provider=redcarpet
--markup=markdown

And set redcarpet as a development dependency in my .gemspec file.

Any help? :(

Thank you.

Reply to this discussion

Internal reply

Formatting help / Preview (switch to plain text) No formatting (switch to Markdown)

Attaching KB article:

»

Attached Files

You can attach files up to 10MB

If you don't have an account yet, we need to confirm you're human and not a machine trying to post spam.

Keyboard shortcuts

Generic

? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac