Using the yard to work with markup files
I've written some documentation for the ruby gem. I am using a shortcut to generate ruby gem reference documentation from ruby source and I want yard to work with this other markdown documentation.
I wrote the documentation on the gitlab quiz that uses the same tag as github and all bindings links work.
When I use yard to generate html from markup, two things go wrong. First, the links don't work because in markdown links, links to other files do not include an extension like. [Getting Started] (Introduction # get-started) which worked on the wiki, but the yard requires [Getting Started] (Introduction.html # get-started). I managed to get around this by writing a rewrite rule in the .htaccess file.
The second problem is more complicated. The wiki-generated header bindings look the same as above, whereas the binary anchors: Introduction.html # Getting_Started
I tried to figure out the problem by adding [NC] to the .htaccess file, but it didn't help. In addition, there is a problem "-" that changes to "_".
The relevant bits from my .yardopts file as per my question:
--markup markdown
--markup-provider redcarpet
My question is:
Is the structure of the generated bindings due to the choice of the markup provider or markup? I'm confused about these terms and I haven't been able to find any helpful documentation about them.
I have github-markup gem installed and I tried replacing markdown with github markup and it didn't work, then I tried replacing redcarpet with github markup but that also doesn't work.
I keep looking for documentation to try and understand what I am doing here without getting any clarity, thus grabbing at straws.
No one has answered this question yet
Check out similar questions: