Patrice Ferlet
c7c18f01cd
- better gomarkdown generation that now fixed the escaped strings, no need to use pandoc anymore - added workflow image - upgraded versions of mkdocs requirements
29 lines
774 B
Markdown
29 lines
774 B
Markdown
<!-- Code generated by gomarkdoc. DO NOT EDIT -->
|
|
|
|
# extrafiles
|
|
|
|
```go
|
|
import "katenary/generator/extrafiles"
|
|
```
|
|
|
|
extrafiles package provides function to generate the Chart files that are not objects. Like README.md and notes.txt...
|
|
|
|
## func [NotesFile](<https://github.com/metal3d/katenary/blob/develop/generator/extrafiles/notes.go#L9>)
|
|
|
|
```go
|
|
func NotesFile() string
|
|
```
|
|
|
|
NoteTXTFile returns the content of the note.txt file.
|
|
|
|
<a name="ReadMeFile"></a>
|
|
## func [ReadMeFile](<https://github.com/metal3d/katenary/blob/develop/generator/extrafiles/readme.go#L25>)
|
|
|
|
```go
|
|
func ReadMeFile(charname, description string, values map[string]any) string
|
|
```
|
|
|
|
ReadMeFile returns the content of the README.md file.
|
|
|
|
Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)
|