CODEWITHSUNDEEP
rubymarkuprdocyard
Joshua Muheim
Joshua Muheim

Reputation: 13233

Is it normal that YARD doesn't replace `code` with <code>code</code>?

I'm just starting to use YARD for documenting my Rails app. I didn't specify any specific Markup handler, but I would have expected that `code` would be converted to code, which doesn't seem to happen. Is this normal behavior? Do I have to add some additional option to make this work? Thank you.

Upvotes: 25

Views: 2754

Answers (3)

Darren Weber
Darren Weber

Reputation: 1674

Without markdown, YARD will display a code block for an indented line, e.g.

  # This is a useful POSIX regex:
  #   [[:lower:]]{2}[[:digit:]]{3}[[:lower:]]{2}[[:digit:]]{4}

Two spaces of indent seem to be sufficient.

Upvotes: 9

Joshua Muheim
Joshua Muheim

Reputation: 13233

From GitHub, I was used to use backticks for inline code comments. So after some research I found the following, very nice solution.

  • Add the redcarpet gem to your Gemfile
  • Run bundle command
  • Add --markup=markdown to your .yardopts file
  • Start YARD server using yard server --reload
  • Open localhost:8808 in your browser

Now you can use Syntax like on GitHub, e.g.

```ruby
def bla; puts 'bla'; end
```

Or

`this is inline code`

Nice! :)

Upvotes: 21

Kashyap
Kashyap

Reputation: 4796

The syntax is a little different from markdown (markdown vs rdoc) I suppose. Using '+' works. +code+ gets rendered in a <code> block.

Upvotes: 22

Related Questions