purescript / purescript/pursuit

Latex math?

Open
#155 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Haskell
Stars
174
Forks
47
PR merge metrics
No merged PRs in 30d

Description

It might be nice to have the ability to put math equations into documentation, probably via latex. I don't really like the way MathJax works but AFAIK there aren't any other good options :(

One example where this might be useful: http://pursuit.purescript.org/packages/purescript-isomorphisms/0.1.0/docs/Data.Iso

Contributor guide

No contributing guide indexed for this repository

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 reviewing the documentation rendering used by Pursuit and the linked PureScript API documentation example. Compare feasible LaTeX and MathJax approaches, then define supported syntax, rendering behavior, and security constraints before implementation. Done means equations render reliably in documentation with documented usage and tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
latex
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.