github-flavored markdown not rendered correctly?

Marc's Avatar

Marc

26 Jul, 2013 06:37 PM

If you look at the documentation for the docile gem, it looks like the github-flavored markdown is not working correctly. Any ideas?

  1. Support Staff 1 Posted by lsegal on 28 Jul, 2013 08:51 AM

    lsegal's Avatar

    GitHub uses a custom renderer to parse markdown content. The redcarpet gem parses slightly differently.

    In general, you need a line of whitespace between any fenced code blocks. This should be true for most markdown parsers that support fenced code blocks.

    Have you tried generating docs locally to see if this happens there too?

  2. 2 Posted by Marc Siegel on 28 Jul, 2013 02:54 PM

    Marc Siegel's Avatar

    Perfect! That was the problem, thanks. Because it rendered correctly on
    Github, I thought that was ok, but you are correct, it rendered locally the
    same as on rubydoc.info, until I added the newlines.

    -Marc

  3. lsegal closed this discussion on 28 Jul, 2013 05:24 PM.

  4. lsegal re-opened this discussion on 28 Jul, 2013 05:24 PM

  5. Support Staff 3 Posted by lsegal on 28 Jul, 2013 05:24 PM

    lsegal's Avatar

    Glad you got it working!

  6. lsegal closed this discussion on 28 Jul, 2013 05:24 PM.

Comments are currently closed for this discussion. You can start a new one.

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