https://github.com/peacock0803sz/khafre
/ˈkæfreɪ, ˈkɑːfreɪ/ Sphinx documentation editor with live preview and embedded terminal.
https://github.com/peacock0803sz/khafre
documentation sphinx
Last synced: 3 months ago
JSON representation
/ˈkæfreɪ, ˈkɑːfreɪ/ Sphinx documentation editor with live preview and embedded terminal.
- Host: GitHub
- URL: https://github.com/peacock0803sz/khafre
- Owner: peacock0803sz
- License: mit
- Created: 2025-12-23T12:05:08.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2026-01-03T08:41:13.000Z (6 months ago)
- Last Synced: 2026-01-06T03:55:36.484Z (6 months ago)
- Topics: documentation, sphinx
- Language: Rust
- Homepage:
- Size: 455 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Khafre
Sphinx documentation editor with live preview and embedded terminal.
## Features
- Live preview with sphinx-autobuild
- Embedded terminal (Neovim integration)
- Split-pane layout (preview + editor)
- Per-project configuration (`.khafre.toml`)
## Installation
Download the latest release from the [Releases](https://github.com/peacock0803sz/khafre/releases) page.
## Usage
1. Open Khafre
2. Select a Sphinx project directory
3. Edit your documentation with live preview
## Configuration
Place `.khafre.toml` in your project root:
```toml
[sphinx]
source_dir = "docs"
build_dir = "_build/html"
[sphinx.server]
port = 0 # 0 = auto-assign
[python]
interpreter = ".venv/bin/python"
[editor]
command = "nvim"
```
### Options
| 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 |
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.