docs

Documentation

Overview

Package docs 打包文档内容

Index

• Constants
• func Dir() core.URI
• func Handler(folder core.URI, stylesheet bool, erro *log.Logger) http.Handler
• func StylesheetURL(prefix string) string

Constants

const FileHeader = "该文件由工具自动生成，请勿手动修改！"

FileHeader 表示输出文件的文件头内容

Functions

func Dir

func Dir() core.URI

Dir 指向 /docs 的路径

func Handler

func Handler(folder core.URI, stylesheet bool, erro *log.Logger) http.Handler

Handler 返回文件服务中间件

如果 folder 为空，表示采用内嵌的数据作为文件服务； stylesheet 是否只返回最基本的样式表相关文件。

func StylesheetURL

func StylesheetURL(prefix string) string

StylesheetURL 生成 apidoc.xsl 文件的 URL 地址

相对于 docs 目录