Documentation

The is the main entry point for Hollow's documentation.

Section	What lives there	Start with
Overview	Install, first run, mental model	Getting started
Guides	Concept-focused how-tos	Configuration
Platforms	Per-OS notes and troubleshooting	Windows + WSL
Reference	API and command surface	Lua API
Examples	Runnable recipes and snippets	Config snippets

Guides

• Getting started — install, first run, mental model
• Configuration — config model, defaults, overrides
• Keybindings — default keymaps, modal bindings, the leader key
• Panes, tabs, workspaces — the three layout primitives
• Themes — built-in themes, custom themes, palette overrides
• Custom UI — top bar, sidebars, overlays, and the widget runtime
• Copy mode — vim-like scrollback navigation and search
• Plugins — installing, authoring, and updating plugins
• Shell integration — what HTP does and how to enable it
• HTP protocol — wire-level protocol reference
• Shell integration recipes — bash, zsh, fish, PowerShell helpers
• Development — build from source, project layout, running tests
• Packaging — release artifacts, runtime layout, WSL bypass, Python client
• Troubleshooting — common failure modes and fixes
• FAQ — short, opinionated answers to recurring questions

Platforms

Per-OS notes for the targets Hollow actually supports or works on today.

• Platform matrix
• Windows
• WSL
• Linux
• macOS

Reference

• Reference index
• Lua API — split per namespace under reference/lua/
  • Overview and conventions
  • hollow.config
  • hollow.term
  • hollow.events
  • hollow.keymap
  • hollow.ui
  • hollow.ui.workspace
  • hollow.theme
  • hollow.htp
  • hollow.fonts
  • hollow.json
  • hollow.workspace
  • hollow.async
  • hollow.process
  • hollow.fs
  • hollow.plugins
  • hollow.util
  • hollow.platform
• CLI
  • CLI index
  • Native hollow cli …
  • Python hollow-cli
• Built-in keymap actions

Examples

Runnable recipes and small, complete snippets.

• Config snippets
• UI recipes
• Plugin authoring