ruby / rdoc

RDoc produces HTML and online documentation for Ruby projects.
https://ruby.github.io/rdoc/
Other
843 stars 438 forks source link

MathJax in template enabled by `rdoc` command line option #376

Open MatteoRagni opened 8 years ago

MatteoRagni commented 8 years ago

Ok, I know this is a particular and difficult thing to request. I hope you'll not hate me for this. But in my University, Ruby is used as first language for students because of its expressiveness. The course is focused on numerical methods implemented in Ruby (not efficient, I know, but easy enough to allow student to understand concepts).

For me it will be really cool if rdoc allows to insert equation using markdown parser, rendered through MathJax in final HTML product (maybe using something like rdoc --markup markdown-with-math ...).

I know it could be possible to add this through an ah-hoc template, but I think that as a new feature could be really useful, also for the guys at SciRuby.

What do you think?

zzak commented 8 years ago

It's a nice idea, but unfortunately I don't have the time to invest in this.

You, or someone, can however implement this template themselves.. and even release it as a gem!

For an example of an rdoc template plugin, see sdoc.

Good luck!