# Helix

## Source

- Repo: `helix-editor/helix` (branch: `main`)
- Book path: `book/src/` (mdBook)
- URL pattern: `https://raw.githubusercontent.com/helix-editor/helix/main/book/src/{file}.md`
- Contents API: `https://api.github.com/repos/helix-editor/helix/contents/book/src`
- Rendered: `https://docs.helix-editor.com/>

## Common chapters

| File                      | Covers                                          |
| ------------------------- | ----------------------------------------------- |
| `install.md`              | Install methods                                 |
| `usage.md`                | First-time usage, basics                        |
| `commands.md`             | Commands quick reference                        |
| `command-line.md`         | `hx` CLI flags                                  |
| `keymap.md`               | Default key bindings (large)                    |
| `editor.md`               | Selections, motions, registers, pickers (large) |
| `configuration.md`        | `~/.config/helix/config.toml`                   |
| `languages.md`            | Tree-sitter grammars and configuration (large)  |
| `lang-support.md`         | Per-language support matrix                     |
| `lsp.md`                  | LSP configuration                               |
| `themes.md`               | Theme system and theme authoring (large)        |
| `pickers.md`              | File picker, buffer picker, global search       |
| `registers.md`            | Register model and access                       |
| `remapping.md`            | Remapping and unbinding keys                    |
| `surround.md`             | Surround-style operations                       |
| `syntax-aware-motions.md` | Tree-sitter motions                             |
| `textobjects.md`          | Text objects (function, class, etc.)            |
| `jumplist.md`             | Jump list behavior                              |
| `from-vim.md`             | Mental model translation from Vim               |
| `building-from-source.md` | Build instructions                              |
| `package-managers.md`     | Per-distro install                              |
| `workspace-trust.md`      | Workspace trust model                           |
| `other-software.md`       | Editor integrations and tooling                 |
| `ecosystem.md`            | Plugins and community resources                 |