github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/gen/commands-md-doc.tmpl (about)

     1  {{ if env "DOCGEN_TARGET=vuepress" }}---
     2  #tag:
     3  #  - {{ md .CategoryID }}
     4  {{ if .Related }}{{ range $i,$a := .Related }}{{ if gt $i 0 }}{{ end }}
     5  #  - {{ md .Hierarchy }}{{ end }}
     6  {{ end }}
     7  ---
     8  
     9  {{ end }}# {{ md .Title }}
    10  {{ if .Summary }}
    11  > {{ md .Summary }}{{ end }}
    12  
    13  ## Description
    14  
    15  {{ md (include .Description) }}
    16  
    17  {{ if .Usage }}## Usage
    18  
    19  {{ md (include .Usage) }}{{ end }}{{ if .Examples }}
    20  
    21  ## Examples
    22  
    23  {{ md (include .Examples) }}{{ end }}{{ if .Flags }}
    24  
    25  ## Flags
    26  
    27  {{ range $i,$a := .Flags }}{{ if gt $i 0 }}
    28  {{ end }}* `{{ md .Flag }}`
    29      {{ md .Description }}{{ end }}{{ end }}{{ if .Detail }}
    30  
    31  ## Detail
    32  
    33  {{ md (include .Detail) }}{{ end }}{{ if .Synonyms }}
    34  
    35  ## Synonyms
    36  
    37  {{ range $i,$a := .Synonyms }}{{ if gt $i 0 }}
    38  {{ end }}* `{{ md . }}`{{ end }}
    39  {{ end }}{{ if .Related }}
    40  
    41  ## See Also
    42  
    43  {{ range $i,$a := .Related }}{{ if gt $i 0 }}
    44  {{ end }}* [{{ md .Title }}](../{{ md .Hierarchy }}.md):
    45    {{ md .Summary }}{{ end }}{{ end }}
    46  
    47  <hr/>
    48  
    49  This document was generated from [{{ .SourcePath }}](https://github.com/lmorg/murex/blob/master/{{ .SourcePath }}).