vars

Documentation

Overview

Package vars 提供了一些公共的函数、结构体及代码级别的设置项。

Index

• Constants
• Variables
• func CommitHash() string
• func DocVersion() string
• func Version() string

Constants

const (
	// 程序的正式名称
	Name = "apidoc"

	// 源码仓库地址
	RepoURL = "https://github.com/caixw/apidoc"

	// 官网
	OfficialURL = "https://apidoc.tools"
)

一些公用的常量

Variables

var AllowConfigFilenames = []string{
	".apidoc.yaml",
	".apidoc.yml",
}

AllowConfigFilenames 允许的配置文件名

apidoc 会按此列表的顺序在目录中查找配置文件， 直到找到第一个相符的文件，或是在没有时出错。

在生成配置文件时，会直接拿第一个元素的值作为文件名。

Functions

func CommitHash

func CommitHash() string

CommitHash Git 上最后的提交记录 hash 值。

func DocVersion

func DocVersion() string

DocVersion 文档的版本号

当文档格式不兼容时，此值也会发生变化。

func Version

func Version() string

Version 完整的版本号