aboutsummaryrefslogtreecommitdiff
path: root/book
diff options
context:
space:
mode:
authorGokul Soumya2022-03-14 02:46:40 +0000
committerGitHub2022-03-14 02:46:40 +0000
commit85492e587cc27ba9783c8380683660a0f4423ff4 (patch)
treeb65d0024e2656d11242c39ec0785e1d444226797 /book
parent1ac576f2b3ab3b3b1c398c57e1269682e6f63f3e (diff)
Deploy docs for master separately (#1783)
* Deploy docs for master separately * Output docs for every tagged release * Update .github/workflows/gh-pages.yml Co-authored-by: Blaž Hrastnik <blaz@mxxn.io>
Diffstat (limited to 'book')
-rw-r--r--book/src/SUMMARY.md2
-rw-r--r--book/src/title-page.md15
2 files changed, 17 insertions, 0 deletions
diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md
index a8f165c0..9e15eee3 100644
--- a/book/src/SUMMARY.md
+++ b/book/src/SUMMARY.md
@@ -1,5 +1,7 @@
# Summary
+[Helix](./title-page.md)
+
- [Installation](./install.md)
- [Usage](./usage.md)
- [Keymap](./keymap.md)
diff --git a/book/src/title-page.md b/book/src/title-page.md
new file mode 100644
index 00000000..c182a753
--- /dev/null
+++ b/book/src/title-page.md
@@ -0,0 +1,15 @@
+# Helix
+
+Docs for bleeding edge master can be found at
+[https://docs.helix-editor.com/master](https://docs.helix-editor.com/master).
+
+See the [usage] section for a quick overview of the editor, [keymap]
+section for all available keybindings and the [configuration] section
+for defining custom keybindings, setting themes, etc.
+
+Refer the [FAQ] for common questions.
+
+[FAQ]: https://github.com/helix-editor/helix/wiki/FAQ
+[usage]: ./usage.md
+[keymap]: ./keymap.md
+[configuration]: ./configuration.md