CODEWITHSUNDEEP
rubygitlabmarkdownyard
R. V.
R. V.

Reputation: 139

yard to generate markdown files instead of html?

I am trying to automate documentation using markdown compatible wiki without having a separate server. I have ruby code with yard compatible documentation. If I run yard doc, it generates html files in ./doc directory.

Would it be possible to generate .md files from the code using yard? So that I can simply add these files to GitLab or GitHub wiki or other markdown supported wiki?

Sorry if the question is repeated.

Upvotes: 3

Views: 981

Answers (1)

skatkov
skatkov

Reputation: 133

Stumbled on this question doing my initial research, but haven't found an answer here. It may sound strange, that some people want to convert documentation no to html, but to markdown instead.

But there are plenty of software that can't render HTML, but works with markdown.

I have developed rdoc plugin to do that. https://github.com/skatkov/rdoc-markdown

Upvotes: 0

Related Questions