Haier

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

>Get Stated

开始使用

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

文档示例

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

环境安装

下面的操作依赖于 Node.js,再进行下面的操作之前请确保你已经安装 Node.js 版本 推荐使用最新的 Node.js 版本。

  • 安装 Picidae
    • 全局安装
  • 初始化项目
    • 修改 picidae 配置

安装 Picidae

全局安装

npm install picidae --global
# 或者
yarn global add picidae 

初始化项目

picidae init my-docs
cd my-docs
# 本地安装 picidae 和 Haier
npm install picidae picidae-theme-haier --save # 更推荐
# 或者全局安装 Haier
picidae use picidae-theme-haier

修改 picidae 配置

完成了上面的步骤后,可以看到 my-docs 目录下,产生了 picidae.config.js 配置文件。
下面将 picidae 配置中使用的主题修改为 Haier

// picidae.config.js
module.exports = {
  theme: 'picidae-theme-haier',
  docRoot: './docs',
  port: 9999
}
开始写文档 →

Copyright © 2018 - Built by Picidae

Powered by 🍔 Haier.