ruby / ruby/rdoc

MathJax in template enabled by `rdoc` command line option

Open
#376 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature Request
Dominant language
Ruby
Stars
930
Forks
465
Avg merge
3d 10h
Merged PRs (30d)
27

Description

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?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how the rdoc command-line options select markup and how an ad-hoc template affects final HTML. Define the behavior of a markdown-with-math option, including equation handling through MathJax, and verify that generated documentation renders the requested equations.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, ruby
Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.