usage-lib 6.0.0

Library for working with usage specs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

{%- set about = spec.about_long | default(value=spec.about | default(value="")) %}
{%- set cmd = spec.cmd %}
{%- set full_cmd = cmd.full_cmd | join(sep=" ") %}
{{- "#" | repeat(count=header_level) }} `{{ (spec.bin ~ " " ~ full_cmd) | trim }}`

**Usage**: `{{ (spec.bin ~ " " ~ cmd.usage) | trim }}`

{%- if spec.version %}

**Version**: {{ spec.version }}
{%- endif %}
{%- if spec.author %}

**Author**: {{ spec.author }}
{%- endif %}
{%- if spec.license %}

**License**: {{ spec.license }}
{%- endif %}
{%- if spec.repository %}

**Repository**: {{ spec.repository }}
{%- endif %}

{%- include "cmd_template.md.tera" %}

{%- set header_level = header_level + 1 %}

{%- for cmd in all_commands | filter(attribute="hide", value=false) %}
{%- if loop.first %}

{{ "#" | repeat(count=header_level) }} Subcommands
{% endif %}
- [`{{ (spec.bin ~ " " ~ cmd.usage) | trim }}`]({{ url_prefix }}/{{ cmd.full_cmd | join(sep="/") }}.md)
{%- endfor %}
{#- The settings page, written beside this one in `--multi` mode by the same run. Gated on
    the same condition that decides whether the page exists at all, so the index never links
    a file that was not written. #}
{%- if config.props or config.files %}

{{ "#" | repeat(count=header_level) }} Configuration

- [Settings]({{ url_prefix }}/{{ config_page }})
{%- endif -%}