文章目录
一、前言
最近笔者需要频繁更新和发布文档,因此有了寻找一个在线markdown文档平台的想法。我最终在作业部落,gitbook,codimd之中选择了codimd,并且将其部署到了自己的服务器以便提高访问速度,因此写下这篇博客记录自己部署和使用的心得,供大家参考借鉴。
二、codimd是什么?
2.1 源于hackmd的超好用markdown编辑器
hackmd是一款著名的在线协作markdown编辑器产品
CodiMD是HackMD的免费开源版本
2.2 codimd的作用
- 在线编辑markdown文档
- 在线发布markdown文档
- 和别人在线协作编辑markdown文档
你可以使用官方提供的codimd服务
三、安装和使用
3.1 安装前需要知道的
- 安装之后你可以使用的功能和官方是一样的
- 安装的好处是,codimd官方的服务器在美国,在国内访问速度慢,部署到自己的服务器可以提高访问速度,也便于自己掌控数据库
- 目前codimd是开放系统,所有人都可以注册和使用你服务器上的codimd服务
3.2 安装步骤
笔者是参考官方文档进行安装的
总共需要以下步骤:
- 在MySQL建立codimd使用的数据库
- 安装git
- 安装docker
- 安装docker-compose
- 安装codimd
3.2.1 创建数据库
笔者使用宝塔面板,因此直接如图添加一个数据库
请注意允许所有ip访问