Skip to content
This repository was archived by the owner on Aug 3, 2024. It is now read-only.
This repository was archived by the owner on Aug 3, 2024. It is now read-only.

Proposal: render math formulas #382

@solatis

Description

@solatis

Hello,

As I understand it, the topic of Haddock being able to render math formulas in a pretty way comes up sometimes. There are several ways to tackle this issue:

  • use graphviz (like doxygen)
  • write a pure haskell implementation of mathtex;
  • use a client side library like MathJax

I would like to start a discussion whether there is any interest in tackling this issue. Personally, I think the MathJax way might be the most pragmatic since it renders everything purely client side: you will not have any additional dependencies for rendering the HTML, and the only thing that is required is including some javascript library and generating proper javascript when math expressions are encountered in haddock markup.

I would be interested in the point of view of the maintainers of haddock on this issue.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions