model

Documentation

Index

• type Config
• type EditorRuntime
• type IOParams
• type LogRuntime
• type MDRuntime
• type PageParams
• type Params
• type Runtime
• type TemplateData

Types

type Config

type Config struct {
	Params  Params
	Runtime Runtime
}

Config 配置文件对应实体

type EditorRuntime

type EditorRuntime struct {
	// 打开配置文件的编辑器命令
	EditorPath string
	// 打开配置文件的编辑器参数
	EditorParams []string
}

EditorRuntime 编辑器相关的参数

type IOParams

type IOParams struct {
	// 文件输出路径
	OutPath string
	// 目标文件类型
	OutType string
}

IOParams 输入输出参数

type LogRuntime

type LogRuntime struct {
	// 控制台输出日志等级
	StdoutLogLevel string
	// 文件记录日志等级
	FileLogLevel string
}

LogRuntime 日志参数

type MDRuntime

type MDRuntime struct {
	// 参考：https://gitlab.com/golang-commonmark/markdown
	// 是否允许 HTML 标签
	EnableHTMLTag bool
	// 是否开启 XHTMLOutput
	EnableXHTMLOutput bool
}

MDRuntime 与 markdown 解析时相关的参数

type PageParams

type PageParams struct {
	// 打印页面格式
	PageFormat string
	// 打印页面方向
	PageOrientation string
	// 打印边距
	PageMargin string
}

PageParams 打印页面参数

type Params

type Params struct {
	// 输入输出参数
	IOParams
	// 打印页面参数
	PageParams
	// 主题
	ThemeName string
	// 指定 Chrome 程序执行路径
	ExecPath string
	// 临时设置控制台日志等级为 "debug"
	Verbose bool
}

Params 可供用户在命令行设置的参数

type Runtime

type Runtime struct {
	LogRuntime
	EditorRuntime
	MDRuntime
}

Runtime 只能在配置文件中设置的参数

type TemplateData

type TemplateData struct {
	MarkdownBody template.HTML
	ThemePath    template.URL
}

TemplateData 替换主题文件 index.html 中的变量