shared

Documentation

Index

• func GenerateTOC(markdown string) string
• type Index
  • func ParseIndex(content []byte) (Index, error)
• type Markdown

Functions

func GenerateTOC

func GenerateTOC(markdown string) string

GenerateTOC generates a simple markdown list, which can be used as TOC for the given markdown file.

Types

type Index

type Index struct {
	Key         string           `json:"key"`
	Name        string           `json:"name"`
	Description string           `json:"description"`
	Home        string           `json:"home"`
	TOC         []map[string]any `json:"toc"`
}

Index is the structure of the index file required in the root directory for each TechDoc.

func ParseIndex

func ParseIndex(content []byte) (Index, error)

ParseIndex parses the given content into the index structure.

type Markdown

type Markdown struct {
	Markdown string `json:"markdown"`
	TOC      string `json:"toc"`
}

Markdown is the structure for returning a markdown file.