document

Documentation

Index

• Variables
• func GetMarkdown(path string) string
• func GetParsed(path string) string
• func GetTitleByPath(path string) string
• func ParseMarkdown(content string) string
• func SearchMdByKey(key string) []string
• func UpdateDocGit()

Variables

var (
	// Path is the document diractory for gf-doc.
	Path = g.Config().GetString("document.path")
)

Functions

func GetMarkdown

func GetMarkdown(path string) string

获得指定uri路径的markdown文件内容

func GetParsed

func GetParsed(path string) string

获得解析为html的markdown文件内容

func GetTitleByPath

func GetTitleByPath(path string) string

根据path参数获得层级显示的title

func ParseMarkdown

func ParseMarkdown(content string) string

解析markdown为html

func SearchMdByKey

func SearchMdByKey(key string) []string

SearchMdByKey searches the markdown files with specified key and returns the file list.

func UpdateDocGit

func UpdateDocGit()

UpdateDocGit does the "git pull" for gf-doc.