haskell / haddock

Haskell Documentation Tool
www.haskell.org/haddock/
BSD 2-Clause "Simplified" License
361 stars 243 forks source link

Feature proposal: Mermaid diagrams #1581

Closed marcosh closed 2 months ago

marcosh commented 1 year ago

When generating html documentation, it would be nice to automatically render Mermaid diagrams.

For example, if some Haskell code contained a comment like

-- | Some docs with a diagram
-- ```mermaid
-- flowchart LR
--    Start --> Stop
-- ```

should render as

Some docs with a diagram

flowchart LR
Start --> Stop
Kleidukos commented 1 year ago

Yes, I had the same idea for a Haddock plugin. Many new things will unlock when we can rework the architecture of Haddock in the near future, so thank you for opening this ticket. :)

Kleidukos commented 2 months ago

I'm closing this for now. Haddock has migrated to Gitlab.