docs

package
v7.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 31, 2020 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package docs 打包文档内容

Index

Constants

View Source
const FileHeader = "该文件由工具自动生成,请勿手动修改!"

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

Variables

This section is empty.

Functions

func Dir

func Dir() core.URI

Dir 指向 /docs 的路径

func Handler

func Handler(folder core.URI, stylesheet bool) http.Handler

Handler 返回文件服务中间件

func StylesheetURL

func StylesheetURL(prefix string) string

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

相对于 docs 目录

Types

type FileInfo

type FileInfo struct {
	Name        string // 相对于打包根目录的地址,同时也会被作为路由地址
	ContentType string
	Content     []byte
}

FileInfo 被打包文件的信息

Directories

Path Synopsis
Package site 用于生成网站内容 包括网站的基本信息,以及文档的翻译内容等。
Package site 用于生成网站内容 包括网站的基本信息,以及文档的翻译内容等。

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL