Notolog Documentation¶
Welcome to the official documentation for Notolog - an open-source Markdown editor built with Python and PySide6.
Quick Links¶
- Getting Started - Installation and first steps
- User Guide - Complete feature overview
- Markdown Syntax - Markdown syntax reference and examples
- AI Assistant - Using AI features (OpenAI, ONNX, llama.cpp)
- Text-to-Speech - Read documents and selections aloud locally
- Configuration - Settings and customization
- API Reference - For developers and contributors
- FAQ & Troubleshooting - Common questions and solutions
What is Notolog?¶
Notolog is a privacy-focused Markdown editor that combines:
- Clean Markdown editing with syntax highlighting
- AI-powered assistance via OpenAI API or local LLMs (ONNX, GGUF)
- Local Text-to-Speech for documents, selections, and reading from the cursor
- File encryption using AES-128 with Fernet
- Multi-language support (19 languages)
- Customizable themes (6 built-in themes)
System Requirements¶
| Requirement | Minimum | Recommended |
|---|---|---|
| Python | 3.11–3.14 | A version supported by all selected dependencies |
| OS | Windows, macOS, or Linux with compatible native dependencies | See installation requirements |
| RAM | 4 GB (base editor) | Additional RAM or VRAM required by the selected local models and context |
| Storage | Space for Notolog and its Python/Qt dependencies | Additional space for downloaded models and notes |
Local LLM Memory Requirements
Memory use depends on the model, quantization, context length, and runtime. Follow the selected model's requirements; parameter count alone does not determine RAM or VRAM needs.
Installation Overview¶
# Using pip (recommended)
pip install notolog
# Using conda
conda install notolog -c conda-forge
# With llama.cpp support
pip install "notolog[llama]"
See Getting Started for detailed installation instructions.
Support¶
- GitHub Issues: Report bugs or request features
- GitHub Discussions: Ask questions and discuss
- Repository: github.com/notolog/notolog-editor
- Website: notolog.app
License¶
Notolog is released under the MIT License.
Documentation for Notolog 1.2.4.