output

Documentation

Overview

Package output 对解析后的数据进行渲染输出。

Index

• func Render(docs *types.Doc, o *Options) error
• type Options
  • func (o *Options) Sanitize() *types.OptionsError

Functions

func Render

func Render(docs *types.Doc, o *Options) error

Render 渲染 docs 的内容，具体的渲染参数由 o 指定。

Types

type Options

type Options struct {
	Dir     string        `yaml:"dir"`              // 文档的保存目录
	Groups  []string      `yaml:"groups,omitempty"` // 仅输出这些组，为空表示输出所有
	Elapsed time.Duration `yaml:"-"`                // 编译用时
	// contains filtered or unexported fields
}

Options 指定了渲染输出的相关设置项。

func (*Options) Sanitize

func (o *Options) Sanitize() *types.OptionsError

Sanitize 对 Options 作一些初始化操作。