output

Documentation

Overview

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

Index

• func Buffer(d *doc.Doc, opt *Options) (*bytes.Buffer, error)
• func Render(d *doc.Doc, opt *Options) error
• type Options

Functions

func Buffer

func Buffer(d *doc.Doc, opt *Options) (*bytes.Buffer, error)

Buffer 将内容导出到内存

func Render

func Render(d *doc.Doc, opt *Options) error

Render 渲染 doc 的内容

Types

type Options

type Options struct {
	// 文档的保存路径
	Path string `yaml:"path,omitempty"`

	// 只输出该标签的文档，若为空，则表示所有。
	Tags []string `yaml:"tags,omitempty"`

	// xslt 文件地址
	//
	// 默认值为 https://apidoc.tools/docs/ 下当前版本的 apidoc.xsl，比如：
	//  https://apidoc.tools/docs/v5/apidoc.xsl
	Style string `yaml:"style,omitempty"`
	// contains filtered or unexported fields
}

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