document

package

v0.0.0-...-0d9af8a Latest Latest Go to latest Published: Mar 30, 2021 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

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

func GetMarkdown(path string) string

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

func GetParsed(path string) string

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

func GetTitleByPath(path string) string

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

func ParseMarkdown(content string) string

解析markdown为html

func SearchMdByKey(key string) []string

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

func UpdateDocGit()

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

This section is empty.