https://github.com/suruibuas/edoc

基于svelte开发的文档工具，只需要编写markdown文件，即可生成在线文档
https://github.com/suruibuas/edoc

Last synced: about 2 months ago
JSON representation

基于svelte开发的文档工具，只需要编写markdown文件，即可生成在线文档

• Host: GitHub
• URL: https://github.com/suruibuas/edoc
• Owner: suruibuas
• License: mit
• Created: 2023-01-10T07:15:01.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-01-28T02:56:43.000Z (almost 2 years ago)
• Last Synced: 2023-10-20T10:27:32.269Z (about 1 year ago)
• Language: Less
• Homepage: http://edoc.eui6.com
• Size: 479 KB
• Stars: 8
• Watchers: 1
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# edoc

#### 演示

[演示](http://edoc.eui6.com)

#### 介绍

基于 svelte 开发的文档工具，只需要编写 markdown 文件，即可生成在线文档。

#### 安装教程

```

// 拉取代码

git clone https://gitee.com/suruibuas/edoc.git

// 进入目录

cd edoc

// 安装依赖

npm i

```

#### 撰写

```

npm run dev

```

#### 打包

```

npm run build

```

#### 使用说明

进入 src/md 目录创建 markdown 文档，目录或者.md 文档前加上序号（1、），左侧栏的目录会按照该序号进行排序

- src

  - md

    - 1、开始

      - 1、概述.md

      - 2、分析.md

    - 2、客户端

      - 1、JAVA.md

      - 2、GO.md

      - 3、PHP.md

      - 4、PYTHON.md

相关配置文件在：`src/config.js` 中

#### 发布

文档编写完成后，运行 `npm run build`，将 `dist` 目录中的文件上传至服务器即可。

#### 交流

官方 QQ 群：651279187（未满）