manifest

Documentation

Index

• Constants
• func AddEditionURI(manif map[string]interface{}, version string, docsDirBase string, ...)
• func AppendExtraCSS(manif map[string]interface{}, cssFile string)
• func AppendExtraJs(manif map[string]interface{}, jsFile string)
• func GetDocsDir(manif map[string]interface{}, manifestFilePath string) string
• func Read(manifestFilePath string) (map[string]interface{}, error)
• func Write(manifestFilePath string, manif map[string]interface{}) error

Constants

const (
	// FileName file name of the mkdocs manifest file.
	FileName = "mkdocs.yml"
	// TempPrefixEnvName temp prefix for environment variable.
	TempPrefixEnvName = "ONOS_TEMP_"
)

Functions

func AddEditionURI

func AddEditionURI(manif map[string]interface{}, version string, docsDirBase string, override bool)

AddEditionURI Adds an edition URI to the "edit_uri" in the manifest file.

func AppendExtraCSS

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

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

func AppendExtraJs

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

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

func GetDocsDir

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

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

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

Write Writes the manifest.