docs/docs-fp-o
21
2
Fork 14
Code Issues 6 Pull requests 1 Projects Activity Actions

RFE: Implement a way to use MermaidJS or some other diagramming solution in docs #14

New issue
Open
opened 2025-09-01 12:12:55 +00:00 by pbokoc · 2 comments
pbokoc commented 2025-09-01 12:12:55 +00:00 (Migrated from gitlab.com)
Copy link

From https://discussion.fedoraproject.org/t/does-the-docs-infrastructure-support-any-graphing-syntax/163060

It would be nice to have a way to use a framework like MermaidJS for creating diagrams and graphs. Antora doesn't appear to have native support for this, but there might be a way around that, because forgejo does.

We could set up a build task that would take Mermaid sources stored in a specific directory inside a repo, and have Forgejo build them and output static images into assets/images, which would then be used in docs normally.

We'll need to investigate this after we migrate to Forgejo.

From https://discussion.fedoraproject.org/t/does-the-docs-infrastructure-support-any-graphing-syntax/163060 It would be nice to have a way to use a framework like MermaidJS for creating diagrams and graphs. Antora doesn't appear to have native support for this, but there might be a way around that, because forgejo does. We could set up a build task that would take Mermaid sources stored in a specific directory inside a repo, and have Forgejo build them and output static images into `assets/images`, which would then be used in docs normally. We'll need to investigate this after we migrate to Forgejo.
pbokoc commented 2025-09-01 12:12:55 +00:00 (Migrated from gitlab.com)
Copy link

set status to To do

set status to **To do**
pbokoc commented 2025-09-01 12:13:25 +00:00 (Migrated from gitlab.com)
Copy link

changed title from RFC: Implement a way to use MermaidJS or some other diagramming solution in docs to RFE: Implement a way to use MermaidJS or some other diagramming solution in docs

<p>changed title from <code class="idiff">RF<span class="idiff left right deletion">C</span>: Implement a way to use MermaidJS or some other diagramming solution in docs</code> to <code class="idiff">RF<span class="idiff left right addition">E</span>: Implement a way to use MermaidJS or some other diagramming solution in docs</code></p>
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
prod
stg
prod-update
No results found.
Labels
Clear labels
  
effort
high
 Will take a long time

  
effort
low
 Easy fix

  
effort
medium
 Will take some time

  
good first issue
Take this if you're new!

  
help wanted
Needs help or feedback from the wider Fedora community

  
meeting topic
Need to discuss this at a Docs team meeting

  
needs changes
Needs changes or fixes before closing

  
needs reporter feedback
Additional feedback or information from the reporter is needed to advance

  
needs review
Someone needs to look at this

  
priority
high
 Fix this NOW NOW NOW!

  
priority
low
 Low priority tasks

  
priority
medium
 Medium priority tasks

  
type/content
Changes to the contents of the site - the actual docs

  
type/misc
Changes to non-content parts of the site. CSS, Actions, scripts, etc.

No labels
effort
high
effort
low
effort
medium
good first issue
help wanted
meeting topic
needs changes
needs reporter feedback
needs review
priority
high
priority
low
priority
medium
type/content
type/misc
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
docs/docs-fp-o#14
No description provided.