README
¶
链滴笔记，连接点滴
💡 简介
链滴笔记是一款开源的桌面端笔记应用，支持 Windows、Mac 和 Linux。
欢迎到链滴笔记官方讨论区了解更多。同时也欢迎关注 B3log 开源社区微信公众号 B3log开源：
✨ 特性
- 为 Markdown 而生
- 支持三种编辑模式
- 所见即所得：对不熟悉 Markdown 的用户较为友好，熟悉 Markdown 的话也可以无缝使用
- 即时渲染：对熟悉 Typora 的用户应该不会感到陌生，理论上这是最优雅的 Markdown 编辑方式
- 分屏预览：适合大屏下的 Markdown 编辑
- 支持数学公式、图表、流程图、甘特图、时序图、五线谱等
- Markdown 文本格式化
- 粘贴 HTML 自动转换为 Markdown
- 配置 Markdown 解析渲染细节参数
- 是否启用脚注支持
- 是否启用 [ToC] 支持
- 是否需要中西文间自动插入空格
- 是否进行自动术语修正
- 中文后跟英文逗号句号等标点是否自动替换为中文对应标点
- 内联数学公式是否允许起始 $ 后紧跟数字
- 数学公式引擎切换 MathJax、KaTeX
- 支持三种编辑模式
- WebDAV 挂载远程目录
- Double Shift 快速导航
- 全文搜索
- 明亮、暗黑两套主题
- 标签聚合分类
TBD - 导出静态站点，内置多套主题
TBD
📸 截图
所见即所得
所见即所得模式对不熟悉 Markdown 的用户较为友好，熟悉 Markdown 的话也可以无缝使用。
即时渲染
即时渲染模式对熟悉 Typora 的用户应该不会感到陌生，理论上这是最优雅的 Markdown 编辑方式。
分屏预览
传统的分屏预览模式适合大屏下的 Markdown 编辑。
明亮主题
暗黑主题
Markdown 配置
全文搜索
🛠️ 安装
安装包
源码构建
- 安装 Go、Node 环境
- 运行项目根目录下的 build 脚本
- 构建成功后将在 app/build 下生成安装包
如果你要修改源码，请按如下步骤搭建开发环境：
- 在 kernel 目录下构建内核并启动
- Windows：
go build -o kernel.exe && kernel.exe - Mac：
go build -o kernel-darwin && ./kernel-darwin - Linux：
go build -o kernel-linux && ./kernel-linux
- Windows：
- 在 app 目录下构建前端
npm run dev并启动主进程npm run start
🏗️ 技术架构
- 通过 Electron 实现主进程，启动后拉起 golang 实现的内核进程
- 内核实现 WebSocket 服务端和主进程交互
- 内核实现 WebDAV 服务端和客户端
- 文件存取（包括操作本地文件）通过 WebDAV 客户端进行
- Markdown 文件启动和挂载时加载到内存实现全文搜索
- 通过 Vditor 编辑器实现 Markdown 所见即所得编辑模式
📜 文档
🏘️ 社区
📄 开源协议
链滴笔记使用 木兰宽松许可证, 第2版 开源协议。
🙏 鸣谢
Directories
Click to show internal directories.
Click to hide internal directories.