思源笔记缘起

动机

在选择了很长一段时间的笔记应用后我发现,市面上还没有任何一款笔记应用能同时满足这两个需求:

这两个需求拆分开来都有现成的产品能够实现,可一旦结合就没有好用的产品了。既然没有,那就创造一个吧。

存储格式

Markdown 的成功除了语法简洁之外,很大一个因素是因为它是一种开放的纯文本格式,使用普通的文本编辑器就可以打开查看和编辑。但随着 Markdown 用户的增多,更多的“高阶”需求逐渐浮出,为了满足这些需求,有不少项目在 Markdown 基础语法的基础上设计了扩展语法。

经过一段时间的调研和尝试,我们确认了使用标准 Markdown 语法(CommonMark/GFM)是无法实现块级引用的,必须引入扩展语法。在众多的 Markdown 扩展语法中,我们选择了 kramdown 提供的内联属性列表(Inline Attribute Lists)语法给块级元素做标识,让每个块级元素都拥有唯一的 ID。这样在引用的时候就能精确地获取到该块。保持 Markdown 文本人类易读写的前提下最大限度地实现通用性和互操作性。

目前并没有太多平台支持 kramdown 扩展语法,如果需要将笔记内容发布到其他平台上,可以通过导出功能来导出标准的 Markdown 文件。

本地离线

笔记应用应该是完全支持离线使用的,只有这样才能保证在最大程度上的可用。在数据同步需求上,已经有很多优秀的解决方案,比如各式各样的云盘服务。

笔记可以说是我们一生的知识积累。从可用性和安全性的角度,在几十年的时间跨度上,没有任何一款云笔记能够保障持续可用,本地文件的可用性是远远大于在线应用的。本地文件只要做好备份(可以定时拷贝到其他离线的存储设备上,也可以通过云盘),基本不会丢失和泄露。云笔记就不一样了,有非常多的可能性导致数据丢失或者泄露,想要通过其他机制做备份也基本不现实。可以说云笔记中的数据是不受用户自己掌控的。

使用云笔记的唯一优势是方便分享,但作为个人知识管理工具来说,分享并不是刚需,或者说并不是高频需求。综上,我们的结论是:无离线,不笔记

拥抱开源

数据可以完全离线以后,还剩下最后一个问题:软件生命周期。

没有任何软件开发团队能保证软件能够持续可用,从开发团队来说,发生软件终止维护的可能性太多了,比如:经费不足、研发目标转移或者遇到不可抗力(比如开发人员突然离世)。

有一种有效的方法可以在最大限度上解决软件停更造成的不可迁移,那就是开源。如果软件有足够价值且是完整开源的,即使主创团队无法继续维护了,其他开发者也能接过重任。从开发团队实际情况出发,完全开源是比较难办到的,虽然开源商业化模式在很多项目上已经大获成功,但并不是每一个项目都适合这样做或者说需要等待适合的时机。

技术架构

B/S 风格

思源笔记整体上采用前后端分离的技术架构,通过 HTTP 实现前后端通讯。

前端

前端目前主要是基于浏览器技术,实现用户交互界面和操作系统平台相关的业务逻辑等。

后端

后端是常驻内存的 HTTP 服务器,实现核心业务逻辑和状态持久化等。默认在 127.0.0.1 上监听 6806 端口。

数据状态

发布包

抽象泄漏和奥康的剃刀

抽象泄露

All non-trivial abstractions, to some degree, are leaky.

所有重大的抽象机制在某种程度上都是有漏洞的。

“抽象泄露”是软件开发领域的术语,它可以推广到很多领域。把较为底层的结构直接暴露出来,将抽象的自由度留给用户是最佳选择。

奥卡姆剃刀原理

奥卡姆剃刀原理(Occam's Razor, Ockham's Razor)又称“奥康的剃刀”,它是由 14 世纪英格兰的逻辑学家、圣方济各会修士奥卡姆的威廉(William of Occam,约 1285 年至 1349 年)提出。这个原理称为“如无必要,勿增实体”,即“简单有效原理”。正如他在《箴言书注》2 卷 15 题说“切勿浪费较多东西去做,用较少的东西,同样可以做好的事情。”

在设计方面,我们应该尽量遵循该原理。所以在思源笔记中,我们基于内容块来构建所有的数据,并使用统一的引用语法,尽量降低用户的使用负担。

广告 我要投放

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...
  • buzzingbee
    订阅者

    我不懂技术,请教一个问题。我有 3 台电脑安装了思源笔记,发现不同电脑得保持相同的软件版本号,否则新版客户端编辑过的笔记,数据同步到其它电脑后,用旧版软件打不开。这样每次软件升级,我就得安装 3 遍,从而保证 3 处电脑上的版本一致,这样比较繁琐。

    看到您这里讲的前后端分离,以及可以用浏览器达到和客户端几乎相同的效果,那么我有一个问题:每次升级是前后端一起升级,还是一般只升级前端,后端几乎保持不变?如果是一般只升级前端,那我是不是只用浏览器,而不重新安装更新的思源版本,就总是能保证能使用到思源的最新版本?或者,浏览器上的插件也随着思源升级也自动升级了,我可以不用经常下载和安装本地的思源?谢谢!

    1 回复
  • 其他回帖
  • 88250
    订阅者 作者

    前后端只是对于开发而言,对于用户而言就是一个整体,所以请尽量都保持所有设备上都是最新版本比较稳妥。

    1 回复
  • songtaoxy
    订阅者

    致敬

  • gymac 1
    订阅者

    唯一同时做到块式编辑器,双链,markdown,本地存储的,D 大加油

  • 查看全部回帖