include references in README

[schmurfy]

Hi, Yard is really nice but I wish I could include parts of the documentation for specific methods/class in the README to avoid repeating it, basically what I try to do is:

# title

  blablabla
  (see #method_with_example)

Is there any way to do this ? (my README is name README.md and rendered accordingly with bluecloth)

[lsegal]

You can look at the available yardoc formatting syntax in the Getting Started guide, specifically inter-document linking. http://rubydoc.info/docs/yard/file/docs/GettingStarted.md#Inter-document_Linking

FYI the mailing list is a better place to ask questions: yardoc@googlegroups.com

[schmurfy]

thanks, I was not sure where to ask this :>