github.com/wheelercj/pm2md@v0.0.11/cmd/default.tmpl (about)

     1  {{- /* template docs: https://pkg.go.dev/text/template */ -}}
     2  
     3  
     4  {{- define "main" -}}
     5  # {{.info.name}}
     6  {{- if .info.description}}
     7  
     8  {{.info.description}}
     9  {{- end}}
    10  {{template "table-of-contents" .}}
    11  {{- template "items" .item}}
    12  {{end -}}
    13  
    14  
    15  {{- define "table-of-contents" -}}
    16  {{- /* The links created by formatHeaderLink work in GitHub. */ -}}
    17  {{- range .item}}
    18  * {{formatHeaderLink .name}}{{if .description}} - {{.description}}{{end}}
    19  {{- end -}}
    20  {{- end -}}
    21  
    22  
    23  {{- define "items"}}
    24  {{- range .}}
    25  
    26  ----------------------------------------
    27  
    28  <details open>
    29      <summary>
    30          <h{{.level}}>
    31              {{- .name -}}
    32          </h{{.level}}>
    33          {{- if .description}} - {{.description}}{{end}}
    34      </summary>
    35  
    36  {{- if .item}}
    37  {{- template "items" .item}}
    38  {{- else -}}
    39  {{- template "request" . -}}
    40  {{- template "responses" . -}}
    41  {{- end}}
    42  </details>
    43  {{- end -}}
    44  {{- end -}}
    45  
    46  
    47  {{- define "request" -}}
    48  {{- if .request.method}}
    49  
    50  {{.request.method}} `/{{join .request.url.path "/"}}`
    51  {{- end -}}
    52  
    53  {{- if .request.description}}
    54  
    55  {{.request.description}}
    56  {{- end -}}
    57  
    58  {{- if .request.body.raw}}
    59  
    60  <h{{add .level 1}}>
    61      {{- "sample request body" -}}
    62  </h{{add .level 1}}>
    63  
    64  ```{{.request.body.options.raw.language}}
    65  {{allowJsonOrPlaintext .request.body.raw}}
    66  ```
    67  {{- end -}}
    68  {{- end -}}
    69  
    70  
    71  {{- define "responses" -}}
    72  {{- range .response}}
    73  
    74  <details>
    75      <summary>
    76          <h{{add .level 1}}>{{- "" -}}
    77              sample response{{if .name}} to {{.name}}{{end}} (status: {{.code}} {{.status}}){{- "" -}}
    78          </h{{add .level 1}}>
    79      </summary>
    80  
    81  ```{{._postman_previewlanguage}}
    82  {{- if .body}}
    83  {{allowJsonOrPlaintext .body}}
    84  {{- else}}
    85  (no response body)
    86  {{- end}}
    87  ```
    88  </details>
    89  {{- end -}}
    90  {{- end -}}
    91  
    92  
    93  {{- template "main" . -}}