Antd-Style Document Website Frame

If you are a front-end engineer, I think you have probably heard of or used UI component libraries such as Antd. They not only have relatively complete UI components, but also do a good job in document management. This library is used to help you quickly generate an Antd-style document static website.

如果你是一个前端工程师，我想你大概听说过或用过Antd这类UI组件库，它们不仅拥有比较完善的UI组件，在文档管理上也做的不错。这个库就是用来帮助大家快速生成一个Antd风格的文档静态网站。

Usage

// local start
yarn start
// normal build
yarn build
// compress into zip files
yarn compress

文档的编写

原则上直接在docs文件夹下面放入markdown文件即可生成页面，但是要注意的是，每个文件的头部需要与自定义的category相对应

---
category: Ancient poems
order: 0
title: 前言
---

这个一个简单、淳朴的文档管理工具。除了能帮您生成文档网站外什么都做不了。

## Hello Hawaii

> 苟利国家生死以，岂因祸福避趋之

```js
let girlfriend = {};
Object.defineProperty(girlfriend, 'love', {
  value: 100,
  writable: false
});

## 主题的常量配置

```js
// 基础配置
const baseConfig = {
  logo: "", // logo 名称
  projectName: "", // 项目名称
  homeUrl: "/index.html", // 静态html位置，注意如果是Nginx等服务器配置需指向该文件
  library: "" // 源码的仓库位置
};

const themeConfig = {
  // 目录配置，按序列配置顺序
  categoryOrder: {
    前言: 0,
    社会主义经济理论: 1,
    概率论与数理统计: 2,
  },
  // 子目录配置
  typeOrder: {
    子目录1: 1
  }
};

当前应用的常量配置

配置文件位于/theme/zh-CH.js中。

module.exports = {
  locale: "zh-CN",
  messages: {
    "app.home.url": "",     // 自定义首页url
    "app.btn.doc": "", // 首页按钮文本
    "app.footer.name": "" // 设置底部文字
  }
};

微信生态转发功能

有些用户有文档转发微信朋友圈的需求，针对这个需求在theme/template/utils文件夹中，有两个文件用于微信H5配置：

• share.jsx
• wechart.jsx