github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/gen/events-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 .Flags }}
    20  
    21  ## Valid Interrupts
    22  
    23  {{ range $i,$a := .Flags }}{{ if gt $i 0 }}
    24  {{ end }}* `{{ md .Flag }}`
    25      {{ md .Description }}{{ end }}{{ end }}{{ if .Payload }}
    26  
    27  ## Payload
    28  
    29  {{ md (include .Payload) }}{{ end }}{{ if .Examples }}
    30  
    31  ## Examples
    32  
    33  {{ md (include .Examples) }}{{ end }}{{ if .Detail }}
    34  
    35  ## Detail
    36  
    37  {{ md (include .Detail) }}{{ end }}{{ if .Related }}
    38  
    39  ## See Also
    40  
    41  {{ range $i,$a := .Related }}{{ if gt $i 0 }}
    42  {{ end }}* [{{ md .Title }}](../{{ md .Hierarchy }}.md):
    43    {{ md .Summary }}{{ end }}{{ end }}
    44  
    45  <hr/>
    46  
    47  This document was generated from [{{ .SourcePath }}](https://github.com/lmorg/murex/blob/master/{{ .SourcePath }}).