Sign inSign up

mobufan/md

By mobufan

•Updated 30 days ago

支持 Markdown 和 OpenAPI 的轻量级文档服务,图库管理、多主题、公开分享。

Buildkit cache
Image
0

3.1K

mobufan/md repository overview

⁠云文档 (md)

一个轻量级的 Markdown + OpenAPI 文档服务器。使用 Vue 3 + Go 构建,支持图库管理、多级文集、多主题和文档公开分享。

⁠核心功能

  • 双编辑器 — Cherry Markdown 富文本编辑 + CodeMirror OpenAPI (YAML/JSON) 语法高亮与校验
  • 图库 — 编辑器内直接上传图片,浏览、插入、重命名、删除、下载,自动生成缩略图
  • 文集树 — 多层级文件夹管理文档,支持拖拽排序和移动
  • 文档发布 — 公开发布为只读链接,OpenAPI 文档可导出为带 Stoplight Elements 渲染的 HTML
  • 多主题 — 8 种编辑器主题 + 明/暗/跟随系统 三种外观模式
  • JWT 双 Token 认证 — access token + refresh token,密码 SHA256 加密
  • 双数据库 — 默认 SQLite,零配置启动;可选 PostgreSQL

⁠快速开始

docker run -d --name md --restart always \
  -p 9900:9900 \
  -v /home/docker/md:/md/data \
  -e reg=true \
  streamerzero/md

打开 http://localhost:9900,注册首个用户即可开始使用。⁠

⁠配置项

参数默认值说明
-p / port9900监听端口
-data / data./data数据目录(数据库、图片)
-reg / regtrue是否开放注册
pg_host-PostgreSQL 主机
pg_port-PostgreSQL 端口
pg_user-PostgreSQL 用户
pg_password-PostgreSQL 密码
pg_db-PostgreSQL 数据库

全部 5 个 PostgreSQL 参数填写后自动使用 PostgreSQL,否则使用 SQLite。

⁠技术栈

层级技术
前端Vue 3 / TypeScript / Vite / Element Plus
后端Go / Iris
编辑器Cherry Markdown / CodeMirror
数据库SQLite / PostgreSQL
构建Docker multi-arch (linux/amd64, linux/arm64)

Tag summary

Content type

Image

Digest

sha256:aa01393ea…

Size

17.8 MB

Last updated

30 days ago

docker pull mobufan/md