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,19 +2,18 @@
# parser
``` go
```go
import "katenary/parser"
```
Parser package is a wrapper around compose-go to parse compose files.
Parser package is a wrapper around compose\-go to parse compose files.
## func Parse
## func [Parse](<https://github.com/metal3d/katenary/blob/develop/parser/main.go#L10>)
``` go
```go
func Parse(profiles []string, dockerComposeFile ...string) (*types.Project, error)
```
Parse compose files and return a project. The project is parsed with
dotenv, osenv and profiles.
Parse compose files and return a project. The project is parsed with dotenv, osenv and profiles.
Generated by [gomarkdoc](https://github.com/princjef/gomarkdoc)
Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)