MinDoc接口管理文档

需求介绍

项目组内部需要一款简单实用的项目接口文档管理和分享的系统.
功能:

  • 用来存储日常接口文档,数据库字典,手册说明等文档;
  • 需要内置项目管理,用户管理,权限管理等功能,满足大部分中小团队的文档管理需求.

MinDoc在Windows下的安装

1 下载可执行文件

请从 https://github.com/lifei6671/mindoc/releases 下载最新版的可执行文件,一般文件名为 mindoc_windows_amd.zip .

2 解压压缩包

请将刚才下载的文件解压,推荐使用好压解压到任意目录。建议不用用中文目录名称。

3 创建数据库

在这里采用sqlite数据库,将 conf/app.conf 中的数据库配置成如下,系统会自动创建 sqlite 数据库文件:

1
2
db_adapter=sqlite3
db_database=mindoc_db

4 配置数据库

  1. 配置文件:

    1
    2
    db_adapter=sqlite3
    db_database=./conf/mindoc_db
  2. 初始化数据库:

    1
    mindoc_windows_amd64.exe install

自动生成管理员账号:admin 密码:123456

5 启动程序

双击mindoc_windows_amd64.exe,访问 http://127.0.0.1:8181

6 导出pdf

  1. 安装whtmltopdf,下载解压到目录;
    whtmltopdf的下载地址:https://wkhtmltopdf.org/downloads.html。
    下载后,安装即可;

  2. 配置文件,指定whtmltopdf路径:

    1
    wkhtmltopdf=C:/Program Files/wkhtmltopdf/bin/wkhtmltopdf.exe

7 安装go环境(如果电脑不存在go环境)

下载地址:https://github.com/lifei6671/mindoc/blob/master/lib/time/zoneinfo.zip?raw=true
设置环境变量:键名为 ZONEINFO,值为MinDoc跟目录下的/lib/time/zoneinfo.zip 绝对路径。

本文标题:MinDoc接口管理文档

文章作者:HT

发布时间:2018年03月16日 - 15:03

最后更新:2018年03月16日 - 19:03

原始链接:http://7ht.gitee.io/2018/03/16/MinDoc接口管理文档/

许可协议: 署名-非商业性使用-禁止演绎 4.0 国际 转载请保留原文链接及作者。