这个是我折腾笔记项目的最后一篇文章了,这个项目是类似于语雀的文档笔记项目,因为我当初想找一个既可以当做笔记,又可以作为团队文档分享的笔记,除了语雀,就发现了这个项目。
这个开源项目的界面或者文档组织方式其实是我最喜欢的,但是我后来放弃它的原因是它的后台编辑逻辑有点不习惯,并且我还是习惯本地写markdown文件。这个项目有高级版和开源版本,高级版终身1000元左右,但是只能保证更新一年,开源版本其实也已经很稳定了,完全够用,也没有引导买付费版的链接广告什么的。
搭建
- 创建一个存放MrDoc数据的文件夹,例如
/docker/MrDoc
,再目录下拉取代码:
bash
git clone https://gitee.com/zmister/MrDoc.git
- 在
/docker
文件夹下创建编写docker-compose.yml
文件
yaml
version: "3"
services:
server:
image: zmister/mrdoc:v7
container_name: mrdoc
restart: unless-stopped
volumes:
- /docker/MrDoc:/app/MrDoc # 持久化数据,:左边路径自己选择好
ports:
- "10086:10086" # 端口
- 在
/docker
中启动
bash
docker-compose up -d
- 访问
访问http://localhost:10086
或者服务器ip+端口访问
管理
创建管理员账户
我们上一步搭建好后还没有账号,现在先创建一个管理员账号。
bash
docker exec -it mrdoc python manage.py createsuperuser
修改用户密码
bash
docker exec -it mrdoc python manage.py changepassword <用户名>
停止容器
bash
docker stop mrdoc
启动容器
bash
docker start mrdoc
删除容器
bash
docker-compose down
# 或者
docker rm -f mrdoc
查看日志
bash
docker logs mrdoc
版本更新
1、在宿主机/容器外的MrDoc项目目录内拉取代码:
bash
git fetch --all && git reset --hard origin/master && git pull
2、重启 Docker 容器
bash
docker restart mrdoc
使用
- 新建编写文章
除了文章编辑,最上边菜单栏支持编辑器切换,导入本地文章,文档文集管理等等。
- 管理
文档管理支持文章的编辑,新增,删除等等。文档管理可以设置权限,是否公开等等。
后记
具体的使用我就不一一列举了,其实除了这款,如果开发人员,还有一款showdoc
项目可能更适合,它可以搭配自己的api调试工具生成接口文档,但是这些文档项目大同小异,有兴趣的可以自己去尝试尝试。
这几篇博客文档类的文章都写的可能比较简单,因为本意只是把自己之前用到的做一个记录,只是给不知道这些项目的人一个提示。