Skip to content

Notolog Editor Documentation

Project Information

Name: Notolog Editor
Type: Python Application - Cross-platform Markdown Editor
License: MIT
Status: Active Development
Platform: Cross-platform Desktop (Windows, macOS, Linux)

Purpose

Notolog is an open-source Markdown editor with integrated AI assistant capabilities, designed for developers, writers, and knowledge workers who need powerful text editing with AI enhancement.

Key Features

  • Markdown Editing: Full-featured Markdown editor with syntax highlighting
  • AI Assistant: Integrated AI powered by OpenAI API, ONNX Runtime, and llama.cpp
  • On-Device LLM: Run large language models locally without internet
  • Encryption: Optional AES-128 file encryption for sensitive documents
  • Multi-Language: Support for multiple interface languages
  • Cross-Platform: Built with Python and PySide6 (Qt)
  • Extensible: Modular architecture for adding new features

Technology Stack

  • Language: Python 3.10+
  • GUI Framework: PySide6 (Qt for Python)
  • AI Backends:
  • OpenAI API
  • ONNX Runtime GenAI
  • llama.cpp (via llama-cpp-python)
  • Encryption: cryptography library (Fernet, AES-128 CBC, PBKDF2)
  • Markdown: Python-Markdown with extensions

Installation

Available through multiple package managers: - PyPI: pip install notolog - Debian/Ubuntu: .deb package - Conda: conda install -c conda-forge notolog - Source: GitHub repository

Use Cases

  1. Technical Writing: Documentation, API docs, technical articles
  2. Note-Taking: Personal knowledge base with AI assistance
  3. Content Creation: Blog posts, articles with AI suggestions
  4. Secure Notes: Encrypted storage for sensitive information
  5. Development: README files, changelogs, project documentation

AI Capabilities

Supported Models

  • Cloud: OpenAI GPT-4o, GPT-5.2, compatible APIs
  • Local ONNX: Microsoft Phi-3, Llama models in ONNX format
  • Local GGUF: Llama, Mistral, Mixtral models via llama.cpp

Additional AI Assistant features:

  • Custom prompt templates
  • Settings UI parameters (temperature, max tokens)
  • Save conversation history as .md files
  • Async requests for non-blocking UI

Target Audience

  • Software developers and engineers
  • Technical writers and documentarians
  • Content creators and bloggers
  • Students and researchers
  • Privacy-conscious users
  • AI/ML enthusiasts

Documentation Structure

  • Getting Started: Installation and quick start guide
  • User Guide: Comprehensive feature documentation
  • AI Assistant: AI integration and model setup
  • AI Modules: Technical details of AI backends
  • Configuration: Settings and customization
  • API Reference: Developer documentation
  • FAQ: Common questions and troubleshooting

Community

  • GitHub: https://github.com/notolog/notolog-editor
  • PyPI: https://pypi.org/project/notolog/
  • Website: https://notolog.app
  • Issues: GitHub Issues for bug reports and feature requests
  • Discussions: GitHub Discussions for questions and community chat

Contributing

Open source project welcoming contributions: - Bug reports and fixes - Feature requests and implementations - Documentation improvements - Translations to new languages - AI module additions

Markdown editor, Python text editor, AI writing assistant, local LLM, ONNX inference, llama.cpp, PySide6 application, encrypted notes, cross-platform editor, open-source editor, on-device AI, privacy-focused editor, technical writing tool, developer tools, knowledge management, note-taking app

Version Information

  • Current Stable: 1.1.x
  • Documentation: Updated regularly
  • API Stability: Stable
  • Breaking Changes: Documented in changelog

Support

  • Documentation: https://notolog.app
  • GitHub Issues: https://github.com/notolog/notolog-editor/issues
  • Discussions: GitHub Discussions

This file is optimized for AI agents and search engines. Last updated: January 2026.