Enhance documentation

- upgraded mkdocs and dependencise (+ add mermaid)
- linted markdown
- add more details
This commit is contained in:
2024-10-18 09:34:57 +02:00
parent 533e1422d0
commit 865473b41b
12 changed files with 227 additions and 183 deletions

View File

@@ -8,10 +8,10 @@ import "katenary/parser"
Parser package is a wrapper around compose\-go to parse compose files.
## func [Parse](<https://github.com/metal3d/katenary/blob/develop/parser/main.go#L25>)
## func [Parse](<https://github.com/metal3d/katenary/blob/develop/parser/main.go#L29>)
```go
func Parse(profiles []string, dockerComposeFile ...string) (*types.Project, error)
func Parse(profiles []string, envFiles []string, dockerComposeFile ...string) (*types.Project, error)
```
Parse compose files and return a project. The project is parsed with dotenv, osenv and profiles.