Rocketnotes 项目介绍
项目概述
Rocketnotes 是一个基于网络的 Markdown 笔记应用程序,结合了大型语言模型(LLM)的文本补全功能。它不仅能帮助用户更高效地记录和管理笔记,还提供有聊天和语义搜索功能。这些功能通过使用一套完全无服务器的RAG(Retrieval-Augmented Generation)管道实现,得益于使用了开源工具,比如 langchain、sentence-transformers、faiss 以及 Ollama。此外,Rocketnotes 还集成了 OpenAI 或者 Anthropic 等AI先进技术。
使用方式
用户可以通过以下多种方式使用 Rocketnotes:
主要功能
- 代码语法高亮:支持用 Markdown 记录带有语法高亮的代码段。
- Katex 和 Mermaid 支持:支持数学和流程图的渲染。
- 层级文档树结构:提供可拖动节点的层级文档树,方便文档组织管理。
- 文档共享:可以与外部用户分享文档。
- 内容搜索与语义搜索:快速查找文档内容,支持高级语义搜索功能。
- 类似 Copilot 的文本补全:自动文本补全功能,提升写作效率。
- 与文档聊天:通过服务器无依赖的RAG技术,与文档进行智能互动。
- 本地模式 Docker 支持:使用 Ollama 或 Sentence Transformers 实现完全本地 RAG。
- 语义存档的 Zettelkasten:使用向量索引,将笔记存入语义高排名的文档中。
- Neovim 插件:rocketnotes.nvim(开发中)
功能详解
与文档聊天与语义搜索
使用 LLM 和向量嵌入的强大功能,可以与笔记“聊天”或者进行语义搜索。
LLM 驱动的文本补全
得到类似 Copilot 的自动文本补全建议。
语义存档的 Zettelkasten
通过向量索引轻松将每日笔记片段保存到语义排名最高的文档中。
创建带语法高亮的代码段
使用 Markdown 的强大与简便性记录个人笔记,轻松创建带语法高亮的代码段。
超快速文档搜索
超快速的全文搜索功能,提供符合搜索模式的文档建议面板。
层级文档树
具有无限深度的子文档层级结构,通过简单的拖放操作重组文档。
贡献方式
最方便的起步方式是通过在 Gitpod 上打开项目,从而获得一个预装好所有包与工具且运行着示例数据的开发环境。
若您更喜欢在本地机器上设置项目,可以查看贡献指南,了解在开发模式下运行项目的必要步骤。无论是反馈潜在bug还是希望添加新功能,任何形式的贡献都是受欢迎的!