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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

{%- 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 }}`

{%- 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 %}

{%- if about %}

{{ about }}
{% endif %}

{%- if spec.examples %}

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

{%- for example in spec.examples %}
{%- if example.header %}

**{{ example.header }}**
{%- endif %}
{%- if example.help %}

{{ example.help }}
{%- endif %}

```{{ example.lang }}
{{ example.code }}
```
{%- endfor %}
{%- endif %}

{%- include "cmd_template.md.tera" %}
{%- set header_level = header_level + 1 %}

{%- for cmd in all_commands %}
{%- set full_cmd = cmd.full_cmd | join(sep=" ") %}

{{ "#" | repeat(count=header_level) }} `{{ (spec.bin ~ " " ~ full_cmd) | trim }}`

{%- include "cmd_template.md.tera" %}
{%- endfor %}
{#- Settings after the commands: a reader looking for a flag wants the command list first,
    and a CLI with no settings renders nothing at all here. #}
{#- A plain `include`, and the blank line before it kept: `{%- include %}` strips the whitespace
    in *this* template, so the section's heading was glued onto the last line of the command
    above it — `Run# Configuration`. And no decrement of `header_level`: the commands render at
    level 2, so dropping to 1 put `# Configuration` beside the document's own title. -#}
{%- if config.props or config.files %}

{% include "config_template.md.tera" %}
{%- endif -%}