Haier

  • 开始使用
  • 帮助
  • 栗子
  • 中文
  • GitHub

>Get Stated

开始使用

  • 环境安装
  • 开始写文档
  • 配置说明
  • 服务端渲染

文档示例

  • 文档例子 a
  • 文档例子 b
编辑

配置说明

  • defaultLang
  • logo
  • description
  • headers
  • repository
  • search
  • style
  • footer

defaultLang

string 'en' | 'zh' (默认: 'en') 当为'en'时,页面默认语言是英文,文档中对应的关系为:
abc.md 对应英文,abc_zh.md 对应中文

当为'en'时,页面默认语言是中文,文档中对应的关系为:
abc.md 对应中文,abc_en.md 对应英文

logo

Object

  • src string Logo 图像的来源 (可选,默认: undefined)
  • name string Logo 名字 (默认: Haier)

description

string 用于首页标题的描述。
可选,默认:"🍔 The universal picidae theme for project / library / framework etc."

headers

[string | Object] 主题头部导航渲染的配置

string 类型对应预设的一些特定类型的导航,如 docs/api/help/i18n/search/github
Object 类型数据结构形为

{
  // 当 ii8n 为空时,导航的内容将以 name 为准
  name: 'Get Started',
  // 如果需要设置不同语言环境下的导航名
  // 可以设置 i18n
  i18n: {
    en: 'Get Started',
    zh: '开始使用'
  },
  // 点击导航将跳转的 url
  // 注意:这里只需要设置英文环境下的 url
  //      Haier 将会根据语言环境自动转换
  url: '/guides/installation'
}

默认为:

[
  {
    i18n: {
      en: 'Get Started',
      zh: '开始使用'
    },
    url: '/guides/installation'
  },
  'help',
  {
    name: 'Example',
    i18n: {
      en: 'Example',
      zh: '栗子'
    },
    url: '/example'
  },
  'i18n', 'search', 'github'
]

repository

Object | string

该配置用于控制 headers 中的 github 导航跳转链接和文档页面的编辑按钮的跳转链接 Object

  • repo string github 仓库地址
    例子:"https://github.com/picidaejs/picidae-theme-haier" 或者 "picidaejs/picidae-theme-haier"
  • branch string 仓库分支,默认"master"
  • prefix string 前缀字符串,用于拼接编辑链接,默认为空

search

Object
基于 docsearch 搜索文档

  • apiKey string 查看 docsearch 配置
  • indexName string 查看 docsearch 配置

style

Object
自定义样式定义,默认值:

  • copyrightColor string 版权信息文字颜色,(默认 "rgba(255, 255, 255, .4)")
  • footerBgColor string 底部背景颜色,(默认 "#808080")
  • themeColor string 主题主颜色,(默认 "#218080")
  • loadingColor string 若loadingColor为空,则为 themeColor 的对比色,(默认 "#dd2f3d")
  • bodyColor string 主题文字颜色,(默认 "#393939")

footer

Object
配置底部信息

  • organization Object 组织相关配置

    • to string 默认 "https://github.com/picidaejs/picidaejs"
    • logo string 默认 "https://github.com/picidaejs/picidaejs/raw/master/logo/picidae-2x.png"
  • copyright string 版权信息,可以为 html 格式 "Copyright © 2018 - Built by Picidae"
← 开始写文档服务端渲染 →

Copyright © 2018 - Built by Picidae

Powered by 🍔 Haier.