docs

package

v0.1.0-alpha Latest Latest Go to latest Published: Feb 9, 2023 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func ProcessCategory(ctx context.Context, c *readme.Client, metadata CatMetadata) error

TODO: improve tracking of final category slug - may need to pass it back

func ProcessDoc(ctx context.Context, c *readme.Client, metadata DocMetadata) error

type CatMetadata struct {
	Title string
	Slug  string
}

type Catalog struct {
	Categories map[string]struct{}
	Docs       map[string]DocMetadata
}

func WalkCatalog(ctx context.Context, docsPath string) (Catalog, error)

type DocMetadata struct {
	Category string
	Parent   string
	Slug     string
	Filepath string
}