Skip to content

Latest commit

 

History

History
131 lines (97 loc) · 6.12 KB

README.md

File metadata and controls

131 lines (97 loc) · 6.12 KB

Rocketnotes

Build Deploy Docker Electron License

Rocketnotes is a web-based Markdown note taking app with LLM-powered text completion, chat and semantic search. It utilizes a 100% Serverless RAG pipeline built with langchain, sentence-transformers, faiss, Ollama, OpenAI, Anthropic and Voyage.

How to use

✨ Features

  • 📝 Code syntax highlighting
  • 📊 Katex and Mermaid support
  • 🌳 Hierarchical document tree with draggable nodes
  • 🌐 Document sharing
  • 🔍 Content search
  • 🔦 Semantic search
  • ✍️ Copilot-like text completion
  • 🤖 Chat with your documents
    • Serverless RAG with faiss, OpenAI, Anthropic, Voyage
  • 📦 Local mode with Docker
    • use Ollama and/or Sentence Transformers for 100% local RAG
  • 📥 Zettelkasten with semantic archiving
    • Use vector index to insert notes into highest semantic-ranked documents
  • 🗣️ Speech-to-text note taking
  • WIP: Neovim plugin rocketnotes.nvim

 

rocketnotes_theme

Chat with your documents or do semantic search

  • 🤖 Use the power of LLMs together with vector embeddings to chat with your notes or search them semantically.

LLM-powered text completion

  • 🤖 Get Copilot-like text completion autosuggestions.

Zettelkasten with semantic archiving

  • ✍️ Save your daily note snippets into zettelkasten.
  • 📥 Use vector index to insert notes into highest semantic-ranked documents with ease.

 

Create code snippets with syntax highlighting

  • 📝 Use the power and simplicity of Markdown for your personal notes.
  • 💻 Create useful code snippets in your favourite programming language with syntax highlighting.
  • 📖 Share documents with external users.

 

Superfast Document Search

  • 🔎 Search through all your documents by content.
  • 🚀 Get an autosuggestion panel with all documents matching you search pattern - superfast!

 

Hierarchical Document Tree

  • 📚 Save your note documents hierarchical with unlimited depth of subdocuments.
  • 🗂️ Structure your notes by simply drag and drop the desired document.
  • 🌟 Pin favourite documents for fast top-level access.

Contributing

A good way to do the first contribution are the good first issues. On some of the issues are already linked PRs with comments in the code what has to be done. These PRs can be picked up if not assigned to someone yet.

The most comfortable way to get started is to open the project in a ready-to-code Gitpod workspace with all packages & tools preinstalled and a running database with sample data.

 

If you prefer to setup the project on your local machine see Contributing Guide and learn all required steps to run it locally in development mode.

Don't hesitate to open an issue for getting some feedback about a potential bug or if you desire a missing feature. It is appreciated to check over current issues and provide feedback to existing ones or even raise a PR which solves an issue. Any contribution is welcome!