task2md

Source code documentation

A CLI tool to generate from Task files, some markdown documentation files for mkdocs static site.

Usage: task2md [OPTIONS] COMMAND [ARGS]...

  A CLI tool to generate markdown documentation files from Task files.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  dir   Command to generate a markdown documentation file from a directory.
  file  Command to generate a markdown documentation file from a Task file.

dir

Get all files with yaml/yml extension from the input directory and generate the markdown files in the output directory.

Usage: task2md dir [OPTIONS]

  Command to generate a markdown documentation file from a directory.

  Raises:     click.ClickException: Error when reading input file or writing
  output file

Options:
  -i, --input DIRECTORY  Input directory  [required]
  -d, --dir DIRECTORY    Output markdown documentation files directory.
                         Default current directory.
  --help                 Show this message and exit.

Example:

task2md dir --input Taskfile.d/ -d doc_dir/

file

Generate from the input file a markdown file in the output directory.

Usage: task2md file [OPTIONS]

  Command to generate a markdown documentation file from a Task file.

  Raises:     click.ClickException: Error when reading input file or writing
  output file

Options:
  -i, --input FILE     Input Task yaml file.  [required]
  -d, --dir DIRECTORY  Output markdown documentation files directory. Default
                       current directory.
  --help               Show this message and exit.

Example:

task2md file --input Taskfile.d/lint.yml -d doc_dir/

Installation

With Python environment

To use:

• Minimal Python version: 3.14

Installation with Python pip:

python3 -m pip install task2md
task2md --help

Authors

• FX Soubirou - Initial work - GitLab repositories

License

This program is free software: you can redistribute it and/or modify it under the terms of the MIT License (MIT). See the LICENSE for details.