Home > @hz-9/docs-build

docs-build package

Classes

Class	Description
Commander	Command Line Argument Parsing Class
DocsBuild	Generate documentation build configuration
DocsOptions	配置文件加载与校验

Interfaces

Interface	Description
AppearanceOptions	外观配置
AutoLinkOptions	Options for <AutoLink>
CommanderOptions	CLI options for @hz-9/docs-build
DocsBuildOptions	@hz-9/docs-build 完整配置选项
DocsBuildResult	程序调用结果
LocalesOptions	多语言配置
NavGroup	Base nav group, has nav items children
NavigationOptions	导航配置
NavItemOptions	Base nav item, displayed as text
SidebarGroupItem
SidebarStructureItem
SiteOptions	站点元信息

Variables

Variable	Description
IGNORE_PATTERNS	預設忽略的文件/目錄模式列表

Type Aliases

Type Alias	Description
NavbarGroupOptions
NavbarLinkOptions
NavbarOptions
SidebarArrayOptions
SidebarObjectOptions
SidebarOptions
SidebarPageItem