kdenote/README.md

53 lines
1.2 KiB
Markdown

# kdenote
KDE integration plugins for [Denote](https://protesilaos.com/emacs/denote) notes.
## Components
- **Baloo extractor** — KFileMetaData plugin that indexes denote file metadata (title, tags, date, signature) so Dolphin search, KRunner, and Baloo queries work on your notes.
- **Dolphin context menu** — "Rename with Denote..." action for files that don't yet conform to the denote naming scheme.
- **Shared library** — Denote filename parsing/building and frontmatter handling (YAML/Org/txt), used by both plugins.
## Building
```sh
mkdir build && cd build
cmake .. -DBUILD_TESTING=ON
make
make install
```
### Dependencies
- Qt 6
- KDE Frameworks 6 (KFileMetaData, KIO, WidgetsAddons, ECM)
- C++20 compiler
## Configuration
Ensure your denote directory is indexed by Baloo:
```sh
balooctl config add includeFolders /path/to/your/notes
```
After installing the extractor plugin, trigger a reindex:
```sh
balooctl check /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`
## License
LGPL-2.1-or-later