0
0
mirror of https://github.com/thegeeklab/wp-plugin-go.git synced 2024-11-21 14:10:39 +00:00
wp-plugin-go/docs/templates/markdown.md.tmpl

16 lines
397 B
Cheetah

{{ with .Name }}# {{ . }}{{ end }}
{{- with .Description }}
{{ . | ToSentence }}
{{- end }}
{{- if .GlobalArgs }}
## Parameters
{{ range $v := .GlobalArgs }}
**_{{ $v.Name }}_**{{ with $v.Default }}{{ if $v.Required }} _required_{{ end }} (defaut: {{ . }}){{ end }}{{ if $v.Description }}{{ "\\" }}{{ end }}
{{- with $v.Description }}
 {{ . | ToSentence }}
{{- end }}
{{ end -}}
{{ end -}}