mkdocs

README

Go MkDocs

Go MkDocs (go-mkdocs) is a package to work with MkDocs. Initial capabilities are to programmatically generate a mkdocs.yml file.

Documentation

Index

• Constants
• func MarkdownExtensionsSimple() []any
• func QuoteString(s string) string
• type Config
  • func (cfg *Config) WriteFileYAML(filename string, perm os.FileMode) error
• type TOC
• type Text
• type Texts
  • func (t Texts) Markdown(prefix, indent string) []string

Constants

const (
	ExtensionAttrList = "attr_list"
	FilenameTOC       = "mkdocs.yml"
	ThemeReadTheDocs  = "readthedocs"
)

Functions

func MarkdownExtensionsSimple

func MarkdownExtensionsSimple() []any

func QuoteString

func QuoteString(s string) string

Types

type Config

type Config struct {
	SiteName           string `json:"site_name" yaml:"site_name"`
	SiteURL            string `json:"site_url" yaml:"site_url"`
	DocsDir            string `json:"docs_dir" yaml:"docs_dir"`
	Theme              string `json:"theme" yaml:"theme"`
	MarkdownExtensions []any  `json:"markdown_extensions,omitempty" yaml:"markdown_extension,omitempty"`
	Nav                Texts  `json:"-" yaml:"-"`
}

func (*Config) WriteFileYAML

func (cfg *Config) WriteFileYAML(filename string, perm os.FileMode) error

type TOC

type TOC struct {
	Permalink []string `json:"permalink"`
}

type Text

type Text struct {
	Key      string
	Val      string
	Children Texts
}

type Texts

type Texts []Text

func (Texts) Markdown

func (t Texts) Markdown(prefix, indent string) []string

Markdown generates a slice of markdown lines. `Texts` is intended to ease the creation of nested key value pairs where they keys may be dynamic values.