Repository navigation
🗺️ Be able to export a Taskfile to markdown documentation w. mermaid dependency graph 📝 #2503
Description
Activity
- changed the title
[-]🗺️ Be able to export a Taskfile to `markdown` documentation w. `mermaid` dependcy graph[/-][+]🗺️ Be able to export a Taskfile to `markdown` documentation w. `mermaid` dependency graph[/+]on Nov 10, 2025 - changed the title
[-]🗺️ Be able to export a Taskfile to `markdown` documentation w. `mermaid` dependency graph[/-][+]🗺️ Be able to export a Taskfile to `markdown` documentation w. `mermaid` dependency graph 📝 [/+]on Nov 10, 2025 - added a commit that references this issue
on Nov 12, 2025 You might find this PR interesting #2348, its possible to geneate documentation in any format you want - including MD Doc.
That inspired me @trulede
Made a first try and it seems like it's working , see
https://github.com/adriens/task-gomplatesI gave it a try on your taskfile (website) :
-
Download the Taskfile and the template file
# Download the Taskfile curl -L https://github.com/go-task/task/raw/main/website/Taskfile.yml -o Taskfile.yml # Download the gomplate template curl -L https://github.com/adriens/task-gomplates/raw/main/tmpl/task-to-md-mermaid.gomplate -o task-to-md-mermaid.gomplate
-
Generate the Markdown Documentation
gomplate -f task-to-md-mermaid.gomplate -d tasks=Taskfile.yml > Taskfile.md
See by yourself below 👇
Taskfile Workflow Diagram
This content was generated thanks to adriens/task-gomplates.
This diagram visualizes the dependencies and flow between tasks defined inTaskfile.yml:Loadinggraph TD build[build] clean[clean] default["**default**"]:::defaultNode deploy:next[deploy:next] deploy:prod[deploy:prod] install[install] lint[lint] preview[preview] build -- deps --> install default -- deps --> install lint -- deps --> install preview -- deps --> build classDef defaultNode fill:#1976D2,color:#fff,stroke:#333,stroke-width:2px;Task Goals and Descriptions
Task Name Description buildBuild website cleanClean temp directories defaultStart website deploy:nextBuild and deploy next.taskfile.dev deploy:prodBuild and deploy taskfile.dev installSetup VitePress locally lintLint website previewPreview Website -
Description
❔ About
I use
taska lot, and someimes, I feel the need to :taskfile to non-programmers to explain them a workflow I implemented withtask👉 I only need to export a kind of
javadocortaskdoc💡 The idea
In addition to
--listoption, would it possible to add the--markdownoption so we could get that kind ofmdoutput :Taskfile Workflow Diagram
This diagram visualizes the dependencies and flow between tasks defined in
Taskfile.yml:graph TD default["**default**"]:::defaultNode -- deps --> generate["generate"] default -- deps --> generate-webp["generate-webp"] default -- deps --> optimize["optimize"] generate -- deps --> setup["setup"] clean["clean"] pdf-logo["pdf-logo"] classDef defaultNode fill:#1976D2,color:#fff,stroke:#333,stroke-width:2px;Task Goals and Descriptions
Copy and paste the Mermaid code into a Markdown viewer that supports Mermaid to see the graph rendered visually.
🔭 Further with
dot/graphvizoptionLike terraform makes it possible, maybe add the option to export to
dot/graphviz