diff options
| author | Blaž Hrastnik | 2021-04-05 06:18:43 +0000 |
|---|---|---|
| committer | Blaž Hrastnik | 2021-04-05 06:48:08 +0000 |
| commit | 16350399ac4eb15274e065f113ad808c96dc600f (patch) | |
| tree | 959a018d3b48fbb7de3975bdfec46d5bb896a830 /book/src | |
| parent | 7d677d32aecfcf3be746ec85c5c31d0a2077e6e3 (diff) | |
Add book/ (mdbook based user guide)
Diffstat (limited to 'book/src')
| -rw-r--r-- | book/src/SUMMARY.md | 7 | ||||
| -rw-r--r-- | book/src/configuration.md | 1 | ||||
| -rw-r--r-- | book/src/hooks.md | 1 | ||||
| -rw-r--r-- | book/src/install.md | 34 | ||||
| -rw-r--r-- | book/src/keymap.md | 18 | ||||
| -rw-r--r-- | book/src/usage.md | 1 |
6 files changed, 62 insertions, 0 deletions
diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md new file mode 100644 index 00000000..474c2e70 --- /dev/null +++ b/book/src/SUMMARY.md @@ -0,0 +1,7 @@ +# Summary + +- [Installation](./install.md) +- [Usage](./usage.md) +- [Configuration](./configuration.md) + - [Keymap](./keymap.md) + - [Hooks](./hooks.md) diff --git a/book/src/configuration.md b/book/src/configuration.md new file mode 100644 index 00000000..a025a48b --- /dev/null +++ b/book/src/configuration.md @@ -0,0 +1 @@ +# Configuration diff --git a/book/src/hooks.md b/book/src/hooks.md new file mode 100644 index 00000000..744f34e8 --- /dev/null +++ b/book/src/hooks.md @@ -0,0 +1 @@ +# Hooks diff --git a/book/src/install.md b/book/src/install.md new file mode 100644 index 00000000..48813bee --- /dev/null +++ b/book/src/install.md @@ -0,0 +1,34 @@ +# Installation + +TODO: Prebuilt binaries on GitHub Releases page + +## OSX + +TODO: brew tap + +``` +$ brew tap helix-editor/helix +$ brew install helix +``` + +## Linux + +### NixOS + +A [flake](https://nixos.wiki/wiki/Flakes) containing the package is available in +the project root. The flake can also be used to spin up a reproducible development +shell for working on Helix. + +### Arch Linux + +TODO: AUR + +## Build from source + +``` +$ git clone --depth 1 --recurse-submodules -j8 https://github.com/helix-editor/helix +$ cd helix +$ cargo install --path helix-term +``` + +This will install the `hx` binary to `$HOME/.cargo/bin`. diff --git a/book/src/keymap.md b/book/src/keymap.md new file mode 100644 index 00000000..995b4688 --- /dev/null +++ b/book/src/keymap.md @@ -0,0 +1,18 @@ +# Keymap + + +## Movement + +| Key | Description | +|-----|-----------| +| h | move left | +| j | move down | +| k | move up | +| l | move right | +| w | move next word start | +| b | move previous word start | +| e | move next word end | + +| Key | Description | +|-----|-----------| +| a | Append to end of selection | diff --git a/book/src/usage.md b/book/src/usage.md new file mode 100644 index 00000000..8f04b05a --- /dev/null +++ b/book/src/usage.md @@ -0,0 +1 @@ +# Usage |