dystudio / liandi Goto Github PK

Logo(TBD)

链滴笔记，连接点滴

链滴笔记是一款开源的桌面端笔记应用，支持 Windows、Mac 和 Linux。

当前项目还处于初始开发阶段，欢迎反馈建议和参与代码贡献

• 为 Markdown 而生
  • 支持传统的分屏编辑预览模式
  • 支持类似 Typora 保留标记符的实时渲染模式
  • 支持所见即所得编辑模式
  • 粘贴 HTML 自动转换为 Markdown
  • Markdown 格式化、语法树实时渲染
  • 支持数学公式、图表、流程图、甘特图、时序图、五线谱
  • 可配置 Markdown 解析渲染细节参数
    • 是否启用脚注支持
    • 是否启用 [ToC] 支持
    • 是否需要中西文间自动插入空格
    • 是否进行自动术语修正
    • 中文后跟英文逗号句号等标点是否自动替换为中文对应标点
    • 内联数学公式是否允许起始 $ 后紧跟数字
    • 数学公式引擎切换 MathJax、Ketax
• 支持 WebDAV 挂载本地或远程目录
• 支持“快速导航”（Double Shift）
• 支持全文搜索
• 支持多主题
• 支持导出静态站点，内置多套主题模板

1. 安装 Go、Node 环境
2. 运行项目根目录下的 build 脚本
3. 构建成功后将在 TBD 下生成安装包

如果你要修改源码，请按如下步骤搭建开发环境：

1. 在 kernel 目录下构建内核并启动 go build && ./kernel
2. 在 app 目录下构建前端 npm run dev 然后启动主进程 npm run start

• 整体通过 Electron 打包运行主进程，实现自动更新机制
• golang 实现 WebSocket 服务端，通过命令模式和主进程交互
• golang 实现后端 WebDAV 服务端和客户端
• 文件存取（包括操作本地文件）通过 WebDAV 客户端进行
• 使用 Vditor 编辑器，默认所见即所得模式

• 链滴笔记路线图

• 讨论区
• 报告问题
• 欢迎关注 B3log 开源社区微信公众号 B3log开源
  

链滴笔记使用 木兰宽松许可证, 第2版 开源协议。

• 浏览器端的编辑器 Vditor
• 对中文语境优化的 Markdown 引擎 Lute
• Go WebDAV 客户端库
• Go 常用工具库
• Go Web 框架 Gin
• Go WebSocket 框架 melody
• 跨平台桌面应用框架 Electron