kdenote/README.md

1.7 KiB

kdenote

KDE integration plugins for Denote notes.

Features

  • Baloo extractor — Indexes denote metadata (title, tags, creation date, signature) into Baloo. Enables Dolphin search, KRunner, and Baloo queries over your notes. Supports frontmatter extraction from Markdown, Org-mode, and plain text files.
  • New Denote File... — Dolphin context menu action (right-click a directory). Creates a new note with the correct denote filename and frontmatter. Choose format: Markdown, Org-mode, or Plain Text.
  • Rename with Denote... — Dolphin context menu action (right-click a non-denote file). Generates a denote-conformant filename, renames atomically, and injects/updates frontmatter.
  • Compound extension support — Handles .md.gpg, .org.age, etc.
  • i18n — Translatable UI. German translation included.

Building

mkdir build && cd build
cmake .. -DBUILD_TESTING=ON
make
ctest
sudo make install

Dependencies

  • Qt 6
  • KDE Frameworks 6 (ECM, KFileMetaData, KIO, WidgetsAddons, I18n)
  • C++20 compiler

Configuration

No configuration required. The plugins activate based on filename pattern recognition — any file whose name starts with a denote identifier (YYYYMMDDTHHMMSS) is recognized, regardless of directory.

If Baloo already indexes your home directory (the default), the extractor works immediately. To reindex existing notes after install:

balooctl index /path/to/your/notes

Denote filename format

YYYYMMDDTHHMMSS[==signature]--slugified-title[__tag1_tag2].ext

Examples:

  • 20240315T120000--my-daily-note__journal_daily.md
  • 20240315T120000==1a--project-plan__work.org
  • 20260712T153000--encrypted-note__private.md.gpg

License

GPL-3.0-or-later