RawMark/README.zh-CN.md

RawMark

在自己的空间，安心写作。

自托管的个人 Markdown 笔记工作台。文件属于你，打开浏览器就能继续写。

English · 简体中文

快速开始 · 使用指南 · 部署文档 · 反馈问题

_{真实工作区，使用示例笔记 · 浅色界面 · 深色界面}

为记录而设计

RawMark 适合想把笔记保存在自己服务器上的个人用户：整理知识、记录项目、收集灵感，在电脑、平板或手机的浏览器中继续写作。

笔记就是普通的 .md 文件，图片放在笔记旁的 assets/ 文件夹。你可以直接访问文件，也可以随时导出，用熟悉的 Markdown 工具打开。

• 专注写作：Markdown 即时预览与源码模式切换，支持表格、任务列表、数学公式、Mermaid 和代码高亮。
• 有条理地整理：文件夹、标签、全文搜索与文章大纲；拖动移动、批量操作、自定义文件图标，让笔记各归其位。
• 延续工作状态：多标签页与固定标签，刷新或重启后恢复；自动保存，外部文件修改同步到页面。
• 让图片跟着笔记走：粘贴、上传与批量导入图片；图片管理支持引用查看、重命名、移动、替换及孤立图片清理。
• 按自己的习惯调整：英文与简体中文、浅色与深色模式，独立的界面、正文及代码字体，可导入字体、自定义快捷键、主题和 CSS 片段。
• 数据可带走：导入 Markdown 或 ZIP，导出笔记与附件；回收站、完整实例备份与设置迁移，支持 API 自动化及前端插件扩展。

RawMark 面向单用户、自托管场景。目前不提供多人协作或公开分享。

快速开始

需要 Git 和 Docker。在本地构建镜像并启动：

git clone https://github.com/eezd/RawMark.git
cd RawMark
docker build -t rawmark .
docker run -d --name rawmark --restart unless-stopped \
  -p 127.0.0.1:21000:8080 \
  -v rawmark-data:/data \
  rawmark

打开 http://localhost:21000，首次访问设置登录密码，即可创建第一篇笔记。数据保存在 Docker 卷 rawmark-data 中，重建容器不会丢失。

以上命令仅监听本机。部署到服务器时，请先完成初始化，再配置 HTTPS 访问；Docker Compose、已有笔记目录接入、备份与升级见部署文档。

文档

想做什么	从这里开始
写作、整理笔记、管理图片与个性化设置	使用指南
部署、配置存储、备份和升级	部署与维护
本地开发、了解目录职责和运行检查	开发指南
编写脚本、接入认证和调用接口	API 与认证

参与项目

欢迎通过 Issues 报告问题或提出建议。报告问题时，请附上版本、部署方式、浏览器和复现步骤；日志与截图中请移除密码、令牌及私人笔记内容。

提交改动前请阅读 AGENTS.md 和开发指南。RawMark 优先保持简单、清晰，较大的功能或架构调整建议先通过 Issue 讨论。

致谢与许可

感谢 CodeMirror、Vue、Element Plus、highlight.js 和 Maple Mono 等项目。前端结构参考 vue3-starter，其 MIT 许可 保留；Maple 字体许可及其他第三方许可遵循各自文件。

RawMark 采用 MIT License 开源；第三方代码与字体保留各自的许可和版权声明。