Thanks to visit codestin.com
Credit goes to Github.com

Skip to content
This repository was archived by the owner on Jan 25, 2026. It is now read-only.
/ khafre Public archive

/ˈkæfreɪ, ˈkɑːfreɪ/ Sphinx documentation editor with live preview and embedded terminal.

License

Notifications You must be signed in to change notification settings

peacock0803sz/khafre

Repository files navigation

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 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:

[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 for development setup and guidelines.

About

/ˈkæfreɪ, ˈkɑːfreɪ/ Sphinx documentation editor with live preview and embedded terminal.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

  •  

Contributors 2

  •  
  •