manifest

package
v1.6.0 Latest Latest
Warning

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

Go to latest
Published: Mar 2, 2019 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source
const FileName = "mkdocs.yml"

FileName file name of the mkdocs manifest file.

Variables

This section is empty.

Functions

func AppendExtraCSS

func AppendExtraCSS(cssFile string, manif map[string]interface{})

AppendExtraCSS Appends a file path to the "extra_css" in the manifest file.

func AppendExtraJs

func AppendExtraJs(jsFile string, manif map[string]interface{})

AppendExtraJs Appends a file path to the "extra_javascript" in the manifest file.

func GetDocsDir

func GetDocsDir(manifestFilePath string, manif map[string]interface{}) (string, error)

GetDocsDir returns the path to the directory pointed by "docs_dir" in the manifest file. If docs_dir is not set, then the directory containing the manifest is returned.

func Read

func Read(manifestFilePath string) (map[string]interface{}, error)

Read Reads the manifest.

func Write added in v1.4.1

func Write(manifestFilePath string, manif map[string]interface{}) error

Write Writes the manifest.

Types

This section is empty.

Jump to

Keyboard shortcuts

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