Using YARD plugins

's Avatar


11 Sep, 2015 08:47 PM

I'm using TomDoc to document one of my gems (curly-templates), but it doesn't seem like the .yardoc file is being respected. Here's the content:

--plugin tomdoc --markup-provider=redcarpet --markup=markdown

Is there something I can do to make this work, or do you intentionally not run plugins due to security concerns?

  1. Support Staff 1 Posted by lsegal on 11 Sep, 2015 08:53 PM

    lsegal's Avatar

    Plugins have to be installed on the host in order to run. Rubydoc does not (currently) have the yard-tomdoc plugin installed, but we would look at a pull request to add it. Check -- someone might have already done this and we just haven't pulled it in.

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


? 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