mise generate task-docs

• Usage: mise generate task-docs [FLAGS]
• Effect: modifies state
• Source code: src/cli/generate/task_docs.rs

Generate documentation for tasks in a project

Flags

• -i --inject — inserts the documentation into an existing file

  This will look for a special comment, <!-- mise-tasks -->, and replace it with the generated documentation. It will replace everything between the comment and the next comment, <!-- /mise-tasks --> so it can be run multiple times on the same file to update the documentation. The file must already contain both comments; mise errors instead of modifying the file if they are missing.

• -I --index — write only an index of tasks, intended for use with --multi

• -m --multi — render each task as a separate document, requires --output to be a directory

• -o --output <OUTPUT> — writes the generated docs to a file/directory

• -r --root <ROOT> — root directory to search for tasks

• -s --style <STYLE>

  Choices: simple, detailed

  Default: simple

• -h --help — Print help

Examples:

mise generate task-docs