Debian Codegraph @

internal/dns/docs/templates/dns.md.tmpl

raw
1 ---
2 title: "{{ .Name }}"
3 date: 2019-03-03T16:39:46+01:00
4 draft: false
5 slug: {{ .Code }}
6 dnsprovider:
7 since: "{{ .Since }}"
8 code: "{{ .Code }}"
9 url: "{{ .URL }}"
10 ---
11
12 <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
13 <!-- {{ .GeneratedFrom }} -->
14 <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
15
16 {{if .Description -}}
17 {{ .Description }}
18 {{else}}
19 Configuration for [{{ .Name }}]({{ .URL }}).
20 {{end}}
21
22 <!--more-->
23
24 - Code: `{{ .Code }}`
25 - Since: {{ .Since }}
26
27 {{if .Example }}
28 Here is an example bash command using the {{ .Name }} provider:
29
30 ```bash
31 {{ .Example -}}
32 ```
33 {{else}}
34 {{ "{{" }}% notice note %}}
35 _Please contribute by adding a CLI example._
36 {{ "{{" }}% /notice %}}
37 {{end}}
38
39 {{if .Configuration }}
40 {{if .Configuration.Credentials }}
41 ## Credentials
42
43 | Environment Variable Name | Description |
44 |-----------------------|-------------|
45 {{- range $k, $v := .Configuration.Credentials }}
46 | `{{$k}}` | {{$v}} |
47 {{- end}}
48
49 The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
50 More information [here]({{ `{{% ref "dns#configuration-and-credentials" %}}` }}).
51 {{- end}}
52
53 {{if .Configuration.Additional }}
54 ## Additional Configuration
55
56 | Environment Variable Name | Description |
57 |--------------------------------|-------------|
58 {{- range $k, $v := .Configuration.Additional }}
59 | `{{$k}}` | {{$v}} |
60 {{- end}}
61
62 The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
63 More information [here]({{ `{{% ref "dns#configuration-and-credentials" %}}` }}).
64 {{- end}}
65 {{- end}}
66
67 {{ .Additional }}
68
69 {{if .Links }}
70 ## More information
71
72 {{if .Links.API -}}
73 - [API documentation]({{ .Links.API }})
74 {{- end}}
75 {{- if .Links.GoClient }}
76 - [Go client]({{ .Links.GoClient }})
77 {{- end}}
78
79 {{- end}}
80
81 <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
82 <!-- {{ .GeneratedFrom }} -->
83 <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->