search

go-task / task

A task runner / simpler Make alternative written in Go
https://taskfile.dev
MIT License
10.78k stars 575 forks source link

Generate documentation based on your taskfile #1695

Open kk-rishang opened 2 months ago

kk-rishang commented 2 months ago

We have option for displaying summary, also we configure input variables. I we use multiple task modules and sharing between teams, document generation tool can really helpout to have better visibility on how to use the task module one created.

I created my own python code to generate docs: https://github.com/Rishang/task-templates/blob/main/generate_docs.py

And here is how the docs look: https://github.com/Rishang/task-templates/blob/main/docs/_aws.md

pd93 commented 1 month ago

I've wanted to overhaul the task formatter for a while so that you can do something like:

task --list --format=json

A nice way to do this might be to support:

task --list --format=markdown

Since most docs servers support some flavour of markdown, this would allow us to support them in a generic way. We could even do this ourselves to document our project Taskfile using our Docusaurus site.