mkdocs

package module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 22, 2023 License: MIT Imports: 2 Imported by: 1

README

Go MkDocs

Build Status Go Report Card Docs License

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func MarkdownExtensionsSimple

func MarkdownExtensionsSimple() []any

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" yaml:"markdown_extension"`
	Nav                []any  `json:"nav" yaml:"nav"`
}

func (*Config) AddNavSimple

func (cfg *Config) AddNavSimple(desc, link string)

func (*Config) WriteFileYAML

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

type TOC

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL