github.com/jimmyfrasche/autoreadme@v0.0.0-20240504231658-aacd7e11c8ba/default.template (about)

     1  {{- define "badge" -}}
     2  [![Go Reference](https://pkg.go.dev/badge/{{ . }}.svg)](https://pkg.go.dev/{{ . }})
     3  {{- end -}}
     4  
     5  {{ with .Module.Deprecated -}}
     6  > [!CAUTION]
     7  > {{ . }}
     8  
     9  {{ end -}}
    10  
    11  {{- $modDocs := not .Module.Documentation.Empty -}}
    12  {{ if and .ProjectRoot $modDocs -}}
    13  {{- if .Package.Command }}{{ template "badge" .Module.Path }}{{ end }}
    14  {{ .Module.Documentation.Markdown 1 }}
    15  ---
    16  {{ end -}}
    17  
    18  # {{ .Package.Name }}
    19  {{- if .Package.Library }}
    20  {{ template "badge" .Package.Import }}
    21  
    22  ```shell
    23  go get {{.Package.Import}}
    24  ```
    25  {{ end }}
    26  
    27  {{ .Package.Documentation.Markdown 2 }}
    28  
    29  ---
    30  Automatically generated by [autoreadme](https://github.com/jimmyfrasche/autoreadme)