一款用于展示markdown文档的轻量级Java应用,适用于公司用作接口文档的管理。
- 未使用任何框架。采用纯servlet、filter实现
- 支持按不同模块管理访问者权限
- [非必]配合linux服务器+git(markdown文档存放在某个git服务器上)可无需登录linux服务器更新文档
- 修改User.java中的
SYS_USER_TOKEN
和SYS_PASSWORD_TOKEN
[如果懒的弄,也可以不改,安全起见改掉:) ] - 将编译好的程序部署到Java应用服务器上(Tomcat、Jetty等)
- 修改
config.properties
配置文件中的 文档根目录- 文档根目录 将存放所有按模块分类的文档(仅n个目录,目录名为模块名),并非直接存放md文件(建议直接在此用git clone一个markdown的文档项目)。
- 模块是指:公司可能存在多个项目文档,每个项目文档应该是一个模块
- 在 文档跟目录 中创建一个目录,假设名为:
xyz
;里面随便写一个md文件,假设为hello.md
(注意:只能以md结尾) - 修改
users.properties
配置文件,配置用户权限- 说明1:
登录名=密码:/模块1权限,/模块2权限
或登录名=密码:*
- 说明2:
=
号左边为登录名;右边为密码和此用户可访问的文档模块权限,密码与权限之间用:
分隔,权限与权限之间用,
分隔,权限以/
开头 - 为刚才的
xyz
目录添加权限:在users.properties
文件中添加一行
- 说明1:
- 启动应用,访问
http://xxx.xxx.xxx:8080/xyz/hello.md
- 如果采用的是linux服务器,并且上述步骤中是直接 文档根目录 中clone的目录,可以直接访问
http://xxx.xxx.xxx/update.do?api=/xyz
来更新(即pull)markdown文档项目 - 如果未采用linux服务器,或没有使用git。只能手动修改 文档根目录 中的文档了 ^_^。大神如果有兴趣,欢迎优化代码!
其他的大家摸索吧!:)