introduce

此Wiki项目使用hexo. 主题使用vue;

如何使用

在source/api目录中添加相关api markdown文件.

新建的文件规则如下:

  1. 在新建的markdown文件顶部添加如下内容 (用于控制显示)

    1
    2
    3
    4
    5
    6
    ---
    title: title
    type: 类别
    subtype: 子类别
    order: 3
    ---

    title为标题; order为排序;
    注: index.md文件的order无效, 使用title进行排序, title以0开头则排在最前, 但是不显示0

  2. 可以在api下建立子文件夹; 子文件夹会自动归为一类菜单; 并且index.md文件为此菜单的父级菜单

文档内的结构

  1. 文章中使用 ## 开头的标题会自动变为一级TOC
  2. 文章中使用 ### 开头的标题会自动变为二级TOC

安装

需要先安装 nodejs;

1
2
3
$ cd wiki
$ npm i hexo-cli -g     # 安装hexo-cli全局库.
$ npm i                 # 在wiki目录下安装需要的依赖库.

生成网站

1
$ npm run build

目录介绍

Project directory structure:

1
2
3
4
5
6
7
─── ./
  └── _dist/                 # 编译出的结果文件.
  └── scaffolds/             # 新建文件的模板.
  └── source/                # wiki文章目录. 忽略隐藏文件(夹)/'_'开头的文件(夹); (除_posts外)
    └── api/                 # api文章目录; api相关的文件在此编写.
    └── guide/               # 项目介绍的文章在此编写.
  └── themes/                # 主题目录.

hexo指令 (了解)

列出结构

命令 说明
hexo list route 列出网站结构
hexo list post 列出所有文章
hexo list page 列出所有页面
hexo list tag 列出所有tag
hexo list category 列出所有category

新建page

1
hexo new [layout] "title"

此项目已经默认创建了两个文章: guide, api; 相关的api文档在 api中新建md文件即可.