62fea05e21
* generate a detailed CLI help * generate a documentation site * new readme
73 lines
1.5 KiB
Cheetah
73 lines
1.5 KiB
Cheetah
---
|
|
title: "{{ .Name }}"
|
|
date: 2019-03-03T16:39:46+01:00
|
|
draft: false
|
|
slug: {{ .Code }}
|
|
---
|
|
|
|
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
|
|
<!-- {{ .GeneratedFrom }} -->
|
|
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
|
|
|
|
{{if .Description -}}
|
|
{{ .Description }}
|
|
{{else}}
|
|
Configuration for [{{ .Name }}]({{ .URL }}).
|
|
{{end}}
|
|
|
|
<!--more-->
|
|
|
|
- Code: `{{ .Code }}`
|
|
{{if .Example }}
|
|
Here is an example bash command using the {{ .Name }} provider:
|
|
|
|
```bash
|
|
{{ .Example -}}
|
|
```
|
|
{{else}}
|
|
{{ "{{" }}% notice note %}}
|
|
_Please contribute by adding a CLI example._
|
|
{{ "{{" }}% /notice %}}
|
|
{{end}}
|
|
|
|
{{if .Configuration }}
|
|
{{if .Configuration.Credentials }}
|
|
## Credentials
|
|
|
|
| Environment Variable Name | Description |
|
|
|-----------------------|-------------|
|
|
{{- range $k, $v := .Configuration.Credentials }}
|
|
| `{{$k}}` | {{$v}} |
|
|
{{- end}}
|
|
|
|
{{- end}}
|
|
|
|
{{if .Configuration.Additional }}
|
|
## Additional Configuration
|
|
|
|
| Environment Variable Name | Description |
|
|
|--------------------------------|-------------|
|
|
{{- range $k, $v := .Configuration.Additional }}
|
|
| `{{$k}}` | {{$v}} |
|
|
{{- end}}
|
|
|
|
{{- end}}
|
|
{{- end}}
|
|
|
|
{{ .Additional }}
|
|
|
|
{{if .Links }}
|
|
## More information
|
|
|
|
{{if .Links.API -}}
|
|
- [API documentation]({{ .Links.API }})
|
|
{{- end}}
|
|
{{- if .Links.GoClient }}
|
|
- [Go client]({{ .Links.GoClient }})
|
|
{{- end}}
|
|
|
|
{{- end}}
|
|
|
|
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
|
|
<!-- {{ .GeneratedFrom }} -->
|
|
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
|