Fixup documentation

- better gomarkdown generation that now fixed the escaped strings, no
  need to use pandoc anymore
- added workflow image
- upgraded versions of mkdocs requirements
This commit is contained in:
2024-04-10 04:51:45 +02:00
parent 2f53638f82
commit c7c18f01cd
11 changed files with 538 additions and 443 deletions

View File

@@ -2,27 +2,27 @@
# extrafiles
``` go
```go
import "katenary/generator/extrafiles"
```
extrafiles package provides function to generate the Chart files that
are not objects. Like README.md and notes.txt…
extrafiles package provides function to generate the Chart files that are not objects. Like README.md and notes.txt...
## func NotesFile
## func [NotesFile](<https://github.com/metal3d/katenary/blob/develop/generator/extrafiles/notes.go#L9>)
``` go
```go
func NotesFile() string
```
NoteTXTFile returns the content of the note.txt file.
## func ReadMeFile
<a name="ReadMeFile"></a>
## func [ReadMeFile](<https://github.com/metal3d/katenary/blob/develop/generator/extrafiles/readme.go#L25>)
``` go
```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)
Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)