docs

package

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

Details

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
}