Sphinx documentation editor with live preview and embedded terminal.
- Live preview with sphinx-autobuild
- Embedded terminal (Neovim integration)
- Split-pane layout (preview + editor)
- Per-project configuration (
.khafre.toml)
Download the latest release from the Releases page.
- Open Khafre
- Select a Sphinx project directory
- Edit your documentation with live preview
Place .khafre.toml in your project root:
[sphinx]
source_dir = "docs"
build_dir = "_build/html"
[sphinx.server]
port = 0 # 0 = auto-assign
[python]
interpreter = ".venv/bin/python"
[editor]
command = "nvim"| Section | Key | Description |
|---|---|---|
sphinx |
source_dir |
Sphinx source directory |
sphinx |
build_dir |
Build output directory |
sphinx.server |
port |
Preview server port (0 = auto) |
python |
interpreter |
Python interpreter path |
editor |
command |
Editor command |
See CONTRIBUTING.md for development setup and guidelines.