# generate_docsify_sidebar

**Repository Path**: solooo/generate_docsify_sidebar

## Basic Information

- **Project Name**: generate_docsify_sidebar
- **Description**: 生成 docsify 文档侧边栏目录
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-09-21
- **Last Updated**: 2021-09-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 生成docsify文档目录

自动生成文档目录

### 根据已有文件遍历生成目录

```shell
python3 generate_sidebar.py
```

* 生成文档目录如下:

    - [分享消息相关接口](/api/app_server/share_msg/index.md)
        - [分享消息设为已读](/api/app_server/share_msg/read_share_msg.md)
        - [删除分享消息](/api/app_server/share_msg/delete_share_msg.md)

* 1、按目录结构遍历；
* 2、当前为目录时，使用目录下的index.md中标题做为目录标题

### 根据配置文件从gitlab下载文档并生成目录

```shell
python3 load_docs.py
```

* 读取 `source/config.yml` 文件
* 根据配置的`gitlab`信息下载相应的文档
* 按原目录保存到本地相对目录
* 生成 `_sidebar.md` 文档

#### 配置文件

```yml

gitlab: # gitlab 配置
  url: https://gitlab.example.net
  accessToken: 

name: API
index: _sidebar.md
path: api/
docs:
- name: 动态域名
  path_pref: /api/app
  path: https://gitlab.example.net/arch/device/-/blob/master/services/get_list.md
- name: 设备列表接口
  docs:
    - name: getDeviceList
      path_pref: /api/app
      path: https://gitlab.example.net/arch/device/-/blob/master/services/get_device_list.md
```

### TODO

- [ ] 生成 `_navbar.md`