Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Is there any way to easily link a file in RDoc?

I want to link to a documentation of a file in RDoc. but the only way I could do is with the following markup:

configuration.rb[link:files/configuration_rb.html]

I would like to do it in a better way, something like this:

<file>configuration.rb</file>

Is there any existing markup rule to do this?

EDIT: of course I've tried without any markup like this configuration.rb but it shows the filename without the link :(

like image 204
KARASZI István Avatar asked Feb 09 '10 17:02

KARASZI István


1 Answers

To display a link in rdoc

{Link label}[url ]

Sample

{Killer question}[http://http://stackoverflow.com/questions/2230954/is-there-any-way-to-easily-link-a-file-in-rdoc]

will create a link of the this question

like image 121
Muntasim Avatar answered Oct 19 '22 04:10

Muntasim