flatnotes 笔记应用 — 一键安装

一款自托管、无数据库的笔记网页应用，使用纯 Markdown 文件构成的扁平文件夹进行存储。

设计原则

flatnotes 旨在成为一款无干扰的笔记应用，将笔记内容置于首位。这意味着：

• 简洁清爽的用户界面。
• 没有文件夹、笔记本或类似结构。只有你的所有笔记，并辅以强大的搜索和标签功能。
• 可在应用内任何位置快速访问全文搜索（键盘快捷键 "/"）。

另一个关键设计原则是不将你的笔记作为人质。你的笔记只是 Markdown 文件。没有数据库、专有格式、复杂的文件夹结构或任何类似的东西。你可以随时自由地将文件移动到其他地方并使用其他应用。

同样，flatnotes 缓存的唯一内容是搜索索引，并且每次搜索时（以及 flatnotes 首次启动时）都会增量同步。这意味着即使在 flatnotes 运行时，你也可以自由地在 flatnotes 之外添加、编辑和删除 Markdown 文件。

有关配置选项的完整列表，请参阅 wiki 中的 环境变量 文章。

问答

数据库在哪里？

没有数据库，只有一个包含 Markdown 文件的文件夹（以及 .flatnotes 子文件夹）。

.flatnotes 子文件夹有什么用？

它存储了笔记内容的全文索引，以实现快速搜索。

我可以删除 .flatnotes 子文件夹吗？

只要 flatnotes 没有运行，当然可以！它会在下次运行 flatnotes 时重新构建。

我可以在 flatnotes 之外添加、编辑和删除 Markdown 文件吗？

可以。flatnotes 缓存的唯一内容是搜索索引，并且每次搜索时（以及 flatnotes 首次启动时）都会同步。

我可以执行高级搜索吗？

是的！请参阅 wiki 页面 高级搜索。

如何将我的笔记从 flatnotes 中导出？

它们只是 Markdown 文件。你可以自由地将文件移动到其他地方并使用其他应用。

有 API 吗？

有。文档可在 /docs 端点获取。例如，参见 demo.flatnotes.io/docs。

如果没有文件夹，我如何组织我的笔记？

第一种选择是不组织。这使你免于整理的负担。然后，你可以依靠 flatnotes 强大的搜索功能来找到你需要的笔记。

此外，你可以在笔记内容的任何位置使用标签（hashtag）来标记笔记，例如 #work。标签与内容的其余部分分开索引，因此可以单独搜索，例如使用字段前缀 "tags:work" 或使用标签快捷方式 "#work"。

支持哪些类型的身份验证？

有三种类型：

• 无 = 无需身份验证，任何可以访问该站点的人都可以使用。
• 密码 = 站点受用户名和密码保护。
• TOTP = 除了用户名和密码外，站点还受基于时间的一次性密码保护。

有关更多信息，请参阅 wiki 中的 环境变量 文章。

路线图

我希望尽可能保持 flatnotes 的简单和无干扰，这意味着限制新功能。尽管如此，我欢迎反馈和建议。

我计划实现的一个功能是分享笔记。本着简单和无数据库的精神，目前的计划是生成临时的预签名 URL，但这需要进一步探索。

赞助

如果你觉得这个项目有用，请考虑请我喝杯咖啡。这会让我很开心。

致谢

特别感谢两个出色的开源项目，它们使 flatnotes 成为可能。

• Whoosh - 一个快速、纯 Python 的搜索引擎库。
• TOAST UI Editor - 一个适用于浏览器的 GFM Markdown 和 WYSIWYG 编辑器。