task2md 1.0.0__tar.gz

task2md-1.0.0/.gitignore

@@ -0,0 +1,18 @@
+# python generated files
+__pycache__/
+*.py[oc]
+.coverage
+build/
+dist/
+reports/
+wheels/
+*.egg-info
+
+# venv
+.venv
+
+.DS_Store
+/.*cache/
+/.devcontainer/
+/styles/
+/Taskfile.d/

task2md-1.0.0/.gitlab-ci.yml

@@ -0,0 +1,34 @@
+---
+include:
+  - remote: 'https://gitlab.com/op_so/projects/gitlab-ci-templates/-/raw/main/templates/lint.gitlab-ci.yml'
+  - remote: 'https://gitlab.com/op_so/projects/gitlab-ci-templates/-/raw/main/templates/lint.python-rye.gitlab-ci.yml'
+  - remote: 'https://gitlab.com/op_so/projects/gitlab-ci-templates/-/raw/main/templates/gitlab-release.gitlab-ci.yml'
+  - remote: 'https://gitlab.com/op_so/projects/gitlab-ci-templates/-/raw/main/templates/python.rye-publish.gitlab-ci.yml'
+
+variables:
+  IMAGE_PYTHON: jfxs/rye
+  LINT_VALE: "true"
+  LINT_MARKDOWN_GLOB: '"**/*.md" "#docs"'
+
+stages:
+  - lint
+  - tests
+  - gitlab-release
+  - pypi-release
+  - pages-release
+
+tests:pytest:
+  image: $IMAGE_PYTHON
+  stage: tests
+  before_script:
+    - rye --version
+    - rye sync
+    - rye run pytest --version
+    - mkdir -p reports/cov
+  script:
+    - rye run test
+
+gitlab-release:
+  before_script:
+    - npx semantic-release --dry-run --no-ci
+    - if [ -s .VERSION ]; then task 00:project-set-version VERSION=$(cat .VERSION); fi

task2md-1.0.0/.markdownlint.yaml

@@ -0,0 +1,9 @@
+---
+# Default state for all rules
+default: true
+
+# Path to configuration file to extend
+extends: null
+
+# MD013/line-length - Line length
+MD013: false

task2md-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+---
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      # Hooks added from sample-config
+      - id: check-executables-have-shebangs
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
+      - id: check-symlinks
+      - id: check-toml
+      - id: check-xml
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]

task2md-1.0.0/.python-version

@@ -0,0 +1 @@
+3.12.2

task2md-1.0.0/.releaserc

@@ -0,0 +1,26 @@
+{
+  "branches": [
+    "main",
+    "master"
+  ],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/exec",
+      {
+        "verifyReleaseCmd": "echo ${nextRelease.version} > .VERSION"
+      }
+    ],
+    [
+      "@semantic-release/gitlab",
+      {
+        "assets": [
+          {
+            "path": "src/"
+          }
+        ]
+      }
+    ]
+  ]
+}

task2md-1.0.0/.vale.ini

@@ -0,0 +1,8 @@
+StylesPath = styles
+
+MinAlertLevel = suggestion
+
+Packages = Microsoft
+
+[*]
+BasedOnStyles = Vale, Microsoft

task2md-1.0.0/.yamllint

@@ -0,0 +1,13 @@
+---
+extends: default
+
+ignore: |
+  .cache/
+  .venv/
+  mkdocs.yml
+  Taskfile.d/
+  Taskfile.yml
+  styles/
+
+rules:
+  line-length: disable

task2md-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2024 FX Soubirou soubirou@yahoo.fr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

task2md-1.0.0/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.3
+Name: task2md
+Version: 1.0.0
+Summary: A program to generate markdown documentation files from Task files
+Project-URL: Homepage, https://gitlab.com/op_so/task/task2md
+Project-URL: Documentation, https://op_so.gitlab.io/task/task2md/
+Author-email: FX Soubirou <soubirou@yahoo.fr>
+License: MIT
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: click>=8.1.7
+Requires-Dist: pydantic>=2.6.3
+Requires-Dist: pyyaml>=6.0.1
+Requires-Dist: types-pyyaml>=6.0.12.12
+Description-Content-Type: text/markdown
+
+# `task2md`
+
+[![Software License](https://img.shields.io/badge/license-MIT-informational.svg?style=for-the-badge)](LICENSE)
+[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release&style=for-the-badge)](https://github.com/semantic-release/semantic-release)
+[![Pipeline Status](https://gitlab.com/op_so/task/task2md/badges/main/pipeline.svg)](https://gitlab.com/op_so/task/task2md/pipelines)
+
+[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://op_so.gitlab.io/task/task2md/) Source code documentation
+
+A CLI tool to generate from [Task](https://taskfile.dev/) files, some markdown
+documentation files for [`mkdocs`](https://squidfunk.github.io/mkdocs-material/) static site.
+
+```bash
+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.
+
+```bash
+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:
+
+```bash
+task2md dir --input Taskfile.d/ -d doc_dir/
+```
+
+## `file`
+
+Generate from the input file a markdown file in the output directory.
+
+```bash
+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:
+
+```bash
+task2md file --input Taskfile.d/lint.yml -d doc_dir/
+```
+
+## Installation
+
+### With `Python` environment
+
+To use:
+
+- Minimal Python version: 3.10
+
+Installation with Python `pip`:
+
+```bash
+python3 -m pip install task2md
+task2md --help
+```
+
+## Authors
+
+<!-- vale off -->
+- **FX Soubirou** - *Initial work* - [GitLab repositories](https://gitlab.com/op_so)
+<!-- vale on -->
+
+## License
+
+<!-- vale off -->
+This program is free software: you can redistribute it and/or modify it under the terms of the MIT License (MIT).
+See the [LICENSE](https://opensource.org/licenses/MIT) for details.
+<!-- vale on -->

task2md-1.0.0/README.md

@@ -0,0 +1,103 @@
+# `task2md`
+
+[![Software License](https://img.shields.io/badge/license-MIT-informational.svg?style=for-the-badge)](LICENSE)
+[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release&style=for-the-badge)](https://github.com/semantic-release/semantic-release)
+[![Pipeline Status](https://gitlab.com/op_so/task/task2md/badges/main/pipeline.svg)](https://gitlab.com/op_so/task/task2md/pipelines)
+
+[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=for-the-badge&logo=MaterialForMkDocs&logoColor=white)](https://op_so.gitlab.io/task/task2md/) Source code documentation
+
+A CLI tool to generate from [Task](https://taskfile.dev/) files, some markdown
+documentation files for [`mkdocs`](https://squidfunk.github.io/mkdocs-material/) static site.
+
+```bash
+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.
+
+```bash
+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:
+
+```bash
+task2md dir --input Taskfile.d/ -d doc_dir/
+```
+
+## `file`
+
+Generate from the input file a markdown file in the output directory.
+
+```bash
+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:
+
+```bash
+task2md file --input Taskfile.d/lint.yml -d doc_dir/
+```
+
+## Installation
+
+### With `Python` environment
+
+To use:
+
+- Minimal Python version: 3.10
+
+Installation with Python `pip`:
+
+```bash
+python3 -m pip install task2md
+task2md --help
+```
+
+## Authors
+
+<!-- vale off -->
+- **FX Soubirou** - *Initial work* - [GitLab repositories](https://gitlab.com/op_so)
+<!-- vale on -->
+
+## License
+
+<!-- vale off -->
+This program is free software: you can redistribute it and/or modify it under the terms of the MIT License (MIT).
+See the [LICENSE](https://opensource.org/licenses/MIT) for details.
+<!-- vale on -->

task2md-1.0.0/Taskfile.project.yml

@@ -0,0 +1,52 @@
+---
+# https://taskfile.dev
+#
+# Taskfile.project.yml for your main project tasks. Must be commited.
+# If you always want the last version of the task templates, add the following line in your .gitignore file
+# /Taskfile.d/
+#
+version: '3'
+
+vars:
+  # TO MODIFY: Task templates to download separated by comma
+  # Example: TASK_TEMPLATES: go,lint,yarn
+  TASK_TEMPLATES: git,lint
+
+tasks:
+
+  00-get-list-templates:
+    # Get the list of templates to download
+    # Do not remove
+    cmds:
+      - echo "{{.TASK_TEMPLATES}}"
+    silent: true
+
+  project-set-version:
+    desc: "[PROJECT] Set version in different files. Arguments: VERSION|V=x.y.z"
+    vars:
+      PY_FILE_VERSION: src/task2md/task2md.py
+      MD_FILE_VERSION: docs/index.md
+      VERSION: '{{default .V .VERSION}}'
+    cmds:
+      - echo "Version {{.VERSION}}"
+      - sed -i.bu "s/0\.0\.0/{{.VERSION}}/g" pyproject.toml
+      - defer: rm -f pyproject.toml.bu
+      - sed -i.bu "s/0\.0\.0/{{.VERSION}}/g" {{.PY_FILE_VERSION}}
+      - defer: rm -f {{.PY_FILE_VERSION}}.bu
+      - sed -i.bu "s/0\.0\.0/{{.VERSION}}/g" {{.MD_FILE_VERSION}}
+      - defer: rm -f {{.MD_FILE_VERSION}}.bu
+    preconditions:
+      - sh: test -n "{{.VERSION}}"
+        msg: "VERSION|V argument is required"
+    silent: true
+
+  30-pre-commit:
+    desc: "[PROJECT] Pre-commit checks."
+    cmds:
+      - date > {{.FILE_TASK_START}}
+      - defer: rm -f {{.FILE_TASK_START}}
+      - task lint:pre-commit
+      - task lint:all MEX='"#docs" "#styles" "#Taskfile.d" "#.venv" "#.cache"'
+      - echo "run also -> rye run lint & rye fmt"
+      - echo "" && echo "Checks Start $(cat {{.FILE_TASK_START}}) - End $(date)"
+    silent: true

task2md-1.0.0/Taskfile.yml

@@ -0,0 +1,187 @@
+---
+# https://taskfile.dev
+#
+# Do not edit this file, instead use Taskfile.project.yml.
+#
+version: '3'
+
+vars:
+  DIR_TASKFILES: Taskfile.d
+  FILE_TASK_START: "task-start-{{.TASK}}.txt"
+  FILE_TASK_START1: "task-start-{{.TASK}}1.txt"
+  TT_GIT_REPO: https://gitlab.com/op_so/task/task-templates/-/raw
+
+includes:
+  00:
+    taskfile: Taskfile.project.yml
+    optional: true
+    # BEGIN-INCLUDES-TEMPLATES
+  git:
+    taskfile: Taskfile.d/git.yml
+    optional: true
+  lint:
+    taskfile: Taskfile.d/lint.yml
+    optional: true
+    # END-INCLUDES-TEMPLATES
+
+tasks:
+
+  install-templates:
+    desc: "[CORE] Download/update tasks templates. Arguments: [PROXY|P=http://proxy:8080] [PROXY_CREDENTIALS|PC=username:password] (*)"
+    summary: |
+      [CORE] Download/update tasks templates.
+      Usage: task install-templates [PROXY|P=http://proxy_url:proxy_port] [PROXY_CREDENTIALS|PC=username:password]
+
+      Arguments:
+       PROXY | P               Proxy URL (optional)
+       PROXY_CREDENTIALS | PC  Proxy credentials username:password (optional)
+
+      Requirements:
+        - wget or curl
+    vars:
+      PROXY: '{{default .P .PROXY}}'
+      D_PROXY: '{{default .TASK_PROXY .PROXY}}'
+      PROXY_CREDENTIALS: '{{default .PC .PROXY_CREDENTIALS}}'
+      TASK_TEMPLATES:
+        sh: task 00:00-get-list-templates
+      FILE: '{{default .F .FILE}}'
+      D_FILE: '{{default "Taskfile.yml" .FILE}}'
+      BEGIN: "    # BEGIN-INCLUDES-TEMPLATES"
+      PATTERN_BEGIN: "^{{.BEGIN}}"
+      END: "# END-INCLUDES-TEMPLATES"
+    cmds:
+      - date > {{.FILE_TASK_START}}
+      - defer: rm -f {{.FILE_TASK_START}}
+      - mkdir -p "{{.DIR_TASKFILES}}"
+      - if [ -z "{{.TASK_TEMPLATES}}" ]; then echo "Error TASK_TEMPLATES variable is empty in Taskfile.project.yml file" && exit 1; else echo "Download templates -> {{.TASK_TEMPLATES}}"; fi
+      - |
+        line_include_template_begin=$(grep -Fn '{{.BEGIN}}' "{{.D_FILE}}" | head -n 1 | cut -d ':' -f 1)
+        line_delete_begin=$(expr $line_include_template_begin + 1)
+        line_include_template_end=$(grep -Fn '{{.END}}' "{{.D_FILE}}" | head -n 1 | cut -d ':' -f 1)
+        line_delete_end=$(expr $line_include_template_end - 1)
+        if [ $line_delete_end -ge $line_delete_begin ]; then
+          sed -i'.bu' "${line_delete_begin},${line_delete_end}d" "{{.D_FILE}}"
+        fi
+      - defer: rm -f "{{.D_FILE}}".bu
+      - |
+        includes="{{.BEGIN}}"
+        for t in $(echo "{{.TASK_TEMPLATES}}" | tr "," " "); do
+          if echo "$t" | grep -q "\[" 2>/dev/null; then
+            task=$(echo "$t" | cut -d '[' -f 1)
+          else
+            task="$t"
+          fi
+          includes="$includes\\n  ${task}:\\n    taskfile: {{.DIR_TASKFILES}}/${task}.yml\\n    optional: true"
+        done
+        sed -i'.bu' "s={{.PATTERN_BEGIN}}=${includes}=g" "{{.D_FILE}}"
+      - |
+        templates_list=$(task 00:00-get-list-templates)
+        for t in $(echo "{{.TASK_TEMPLATES}}" | tr "," " "); do
+          if echo "$t" | grep -q "\[" 2>/dev/null; then
+            task=$(echo "$t" | cut -d '[' -f 1)
+            v=$(echo "$t" | sed -e 's/.*\[\(.*\)\]/\1/')
+            version="v${v}"
+          else
+            task="$t"
+            version="main"
+          fi
+          echo "Download template: $task version: $version"
+          task download-template TEMPLATE=${task}.yml VERSION=$version PROXY={{.D_PROXY}} PROXY_CREDENTIALS={{.PROXY_CREDENTIALS}}
+        done
+      - echo "Install templates Start $(cat {{.FILE_TASK_START}}) - End $(date)"
+    silent: true
+
+  usage:
+    desc: "[CORE] Show the usage of a task. Arguments: TSK|T=task-name [FILE|F=Taskfile.dist.yml] (*)"
+    summary: |
+      [CORE] Show the usage of a task.
+      Usage: task [-t Taskfile.dist.yml] usage TSK|T=<task-name> [FILE|F=Taskfile.dist.yml]
+
+      Arguments:
+       TSK | T  Name of the task (required)
+       FILE | F Taskfile path (optional, by default Taskfile.yml)
+    vars:
+      TSK: '{{default .T .TSK}}'
+      FILE: '{{default .F .FILE}}'
+      D_FILE: '{{default "Taskfile.yml" .FILE}}'
+    cmds:
+      - |
+        if [ ! -f "{{.D_FILE}}" ]; then
+          echo "{{.D_FILE}} does not exist!"
+          exit 1
+        fi
+      - task -t "{{.D_FILE}}" --summary "{{.TSK}}" | sed '/^dependencies:$/,$d' | sed '/^commands:$/,$d'
+    preconditions:
+      - sh: test -n "{{.TSK}}" || test -n "{{.T}}"
+        msg: "TSK|T argument is required"
+    silent: true
+
+  default:
+    desc: "[CORE] List of available tasks. Arguments: [FILE|F=Taskfile.project.yml] (*)"
+    summary: |
+      [CORE] Show the list of available tasks.
+      Usage: task [FILE|F=Taskfile.project.yml]
+
+      Arguments:
+       FILE | F Taskfile project path (optional, by default Taskfile.project.yml)
+    vars:
+      FILE: '{{default .F .FILE}}'
+      D_FILE: '{{default "Taskfile.project.yml" .FILE}}'
+    cmds:
+      - |
+        if [ -d "{{.DIR_TASKFILES}}" ]; then
+          ls -1 {{.DIR_TASKFILES}}/*.yml |
+          while IFS= read -r template; do
+            template_name=$(basename "$template")
+            printf "\033[0;33m[ %s: ]\033[0m " "${template_name%.yml}" && task --list -t "$template" || true
+            echo ""
+          done
+        fi
+      - |
+        if [ ! -z "{{.D_FILE}}" ]; then
+            printf "\033[0;33m[ %s: ]\033[0m " "00" && task --list -t "{{.D_FILE}}" || true
+        fi
+      - echo ""
+      - echo " <task install-templates [PROXY|P=http://proxy:8080]> to install or update templates (Variable TASK_TEMPLATES in Taskfile.project.yml file)."
+      - echo " (*) <task usage TSK=task-name> will show the usage of the task."
+    silent: true
+
+  download-template:
+    cmds:
+      - |
+        if [ -x "$(command -v curl)" ]; then
+          if [ -z "{{.PROXY}}" ]; then
+            curl --progress-bar -o "{{.DIR_TASKFILES}}/{{.TEMPLATE}}" "{{.TT_GIT_REPO}}/{{.VERSION}}/{{.DIR_TASKFILES}}/{{.TEMPLATE}}"
+          else
+            if [ -z "{{.PROXY_CREDENTIALS}}" ]; then
+              echo "Proxy: {{.PROXY}}"
+              curl -x "{{.PROXY}}" --progress-bar -o "{{.DIR_TASKFILES}}/{{.TEMPLATE}}" "{{.TT_GIT_REPO}}/{{.VERSION}}/{{.DIR_TASKFILES}}/{{.TEMPLATE}}"
+            else
+              echo "Proxy with auth: {{.PROXY}}"
+              curl -U "{{.PROXY_CREDENTIALS}}" -x "{{.PROXY}}" --progress-bar -o "{{.DIR_TASKFILES}}/{{.TEMPLATE}}" "{{.TT_GIT_REPO}}/{{.VERSION}}/{{.DIR_TASKFILES}}/{{.TEMPLATE}}" --proxy-anyauth
+            fi
+          fi
+        else
+          if [ -z "{{.PROXY}}" ]; then
+            wget -cq -O "{{.DIR_TASKFILES}}/{{.TEMPLATE}}" "{{.TT_GIT_REPO}}/{{.VERSION}}/{{.DIR_TASKFILES}}/{{.TEMPLATE}}"
+          else
+            if [ -z "{{.PROXY_CREDENTIALS}}" ]; then
+              proxy={{.PROXY}}
+              echo "Proxy: $proxy"
+            else
+              proto=$(echo {{.PROXY}} | sed -e's,^\(.*://\).*,\1,g')
+              url=$(echo {{.PROXY}} | sed -e's,^.*://\(.*\),\1,g')
+              proxy="${proto}{{.PROXY_CREDENTIALS}}@${url}"
+              echo "Proxy: ${proto}****:****@${url}"
+            fi
+            export use_proxy=on && export http_proxy=$proxy && export https_proxy=$proxy && wget -cq -O "{{.DIR_TASKFILES}}/{{.TEMPLATE}}" "{{.TT_GIT_REPO}}/{{.VERSION}}/{{.DIR_TASKFILES}}/{{.TEMPLATE}}"
+          fi
+        fi
+    preconditions:
+      - sh: test -n "{{.TEMPLATE}}"
+        msg: "TEMPLATE argument is required"
+      - sh: test -n "{{.VERSION}}"
+        msg: "VERSION argument is required"
+      - sh: command -v curl || command -v wget
+        msg: "curl or wget are not installed"
+    silent: true

task2md-1.0.0/docs/cli.md

@@ -0,0 +1,11 @@
+# CLI Reference
+
+This page provides documentation for the command line `task2md` application.
+
+::: mkdocs-click
+    :module: task2md.task2md
+    :command: dir
+
+::: mkdocs-click
+    :module: task2md.task2md
+    :command: file

task2md-1.0.0/docs/index.md

@@ -0,0 +1,6 @@
+# Overview
+
+Version: 1.0.0
+
+A CLI tool to generate from [Task](https://taskfile.dev/) files, some markdown
+documentation files for [`mkdocs`](https://squidfunk.github.io/mkdocs-material/) static site.

task2md-1.0.0/docs/task/file.md

@@ -0,0 +1,2 @@
+
+::: src.task2md.task.file

task2md-1.0.0/docs/task/header.md

@@ -0,0 +1,2 @@
+
+::: src.task2md.task.header

task2md-1.0.0/docs/task/task.md

@@ -0,0 +1,2 @@
+
+::: src.task2md.task.task

task2md-1.0.0/docs/task/variable.md

@@ -0,0 +1,2 @@
+
+::: src.task2md.task.variable

task2md-1.0.0/docs/task2md.md

@@ -0,0 +1,2 @@
+
+::: src.task2md.task2md

task2md-1.0.0/docs/util/dir.md

@@ -0,0 +1,2 @@
+
+::: src.task2md.util.dir

task2md-1.0.0/lychee.toml

@@ -0,0 +1 @@
+exclude_path = ["styles"]