夜雨聆风学习资料网

ARTICLE · 1043694

开源轻量Markdown笔记软件HedgeDoc安装及使用教程,支持历史版本、实时协作、各类图表公式等 | 开源笔记

开源轻量Markdown笔记软件HedgeDoc安装及使用教程,支持历史版本、实时协作、各类图表公式等 | 开源笔记

HedgeDoc是一个开源自托管的轻量Markdown笔记软件,前身为CodiMD,具有基于Web、自托管、实时协作、幻灯片模式reveal.js、图表支持、权限系统、历史版本、低配置要求等功能。

01
HedgeDoc安装教程

如果复制官方文档的Docker命令则无法正常运行,需要修改Postgres版本为16,修改IP地址、修改密码,参照以下docker-compose.yml文件示例:

services:  database:    image: postgres:16-alpine    environment:      - POSTGRES_USER=hedgedoc      - POSTGRES_PASSWORD=a8o894i3x54cf3 # 修改密码      - POSTGRES_DB=hedgedoc    volumes:      - database:/var/lib/postgresql/data    restart: always  app:    # Make sure to use the latest release from https://hedgedoc.org/latest-release    image: quay.io/hedgedoc/hedgedoc:1.12.0    environment:      - CMD_DB_URL=postgres://hedgedoc:a8o894i3x54cf3@database:5432/hedgedoc # 修改为与第6行相同的密码      - CMD_DOMAIN=192.168.1.99 # 修改IP      - CMD_URL_ADDPORT=true    volumes:      - uploads:/hedgedoc/public/uploads    ports:      - "3000:3000"    restart: always    depends_on:      - databasevolumes:  database:  uploads:

或者直接获取本站修改好的脚本:

wget https://git.ossdate.com/fivemoons/oss-scripts/raw/branch/main/hedgedoc/docker-compose.yml

运行:

docker compose up -d

使用浏览器打开IP:3000,在登录窗口填好信息点击“注册”新增账号:

02
HedgeDoc使用教程

HedgeDoc内置一个功能介绍页面,点击头像-功能或者在网址后加/features即可访问:

http://192.168.1.99:3000/features

新建文档默认打开双栏预览模式:

除常用的Markdown语法外,HedgeDoc支持语法扩展比如信息框:

输入英文:+表情英文名称选择emoji表情:

支持语法高亮,=后跟代码块的起始行数:

支持使用MathJax输入数学公式:

支持流程图、时序图、Mermaid图、Graphviz图:

甚至支持乐谱:

图片的上传方式有上传、拖拽、粘贴:

支持在文档头部添加元数据:

---title: meta titledescription: meta descriptiontags: features, cool, updatedrobots: noindex, nofollow---## 等等

右侧自动生成文档目录ToC,也可以输入[TOC]在页面中插入目录:

可以自行设置页面的权限:

若将链接分享出去,就可以与同事进行实时协作编辑,甚至假装写文档,实际在聊天摸鱼:

所有的文档都直接在首页显示:

分类依据只有文档头部元数据中的标签,除此之外再没有其他分类依据:

搜索仅支持标题搜索,不支持全文搜索:

从公开信息来看HedgeDoc有版本2的开发计划,但已经2年没动静了,1.x版本是目前比较推荐使用的稳定版本。

更多技术细节请查看项目地址:

https://github.com/hedgedoc/hedgedoc

类似HedgeDoc的其他项目还有:

适合技术团队使用的文档工具ShowDoc安装及使用教程,支持创建API文档、数据字典、文档教程等 | 开源文档管理

开源IT项目文档管理系统MinDoc安装及使用教程

开源协作Wiki和文档软件Docmost安装及使用教程,支持多用户实时协作、页面历史、公式图表等,2026年更新 | 开源Wiki知识库软件

相关学习资料