KLookup developer documentation

KLookup is a KDE Plasma desktop lookup application built with C++17, Qt 6 and KDE Frameworks 6. These guides document current desktop behaviour and provider extension points.

For installation, source builds and contribution instructions, see the repository README and contributor guide. Source and automated tests remain authoritative for implemented behaviour.

Desktop behaviour

• Autostart on login, global shortcuts and clipboard privacy.
• Recent activity and result interactions.
• Typed result metadata for provider data.

Provider development

• Package installation and approval, authentication and diagnostics.
• Script lifecycle, HTTP transport and continuation contract.
• Provider-specific guides: Wikipedia, MangaBaka, Spotify, AniList, Lyrics.ovh and Open Library.

Preview locally

Install the same documentation generator used in CI through the Python package manager:

python -m pip install 'mkdocs==1.6.1'
mkdocs serve

CI validates the site on pull requests and deploys from a fully validated main build only after the repository's GitHub Pages source is configured for GitHub Actions. The site is documentation, not a software release.