From 9db4794a88d6377ea23b08fb5619e9e9a8d02c2e Mon Sep 17 00:00:00 2001
From: Shin'ya UEOKA <ueokande@i-beam.org>
Date: Fri, 6 Sep 2019 04:17:44 +0000
Subject: Add help pages from readme

---
 docs/properties.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 docs/properties.md

(limited to 'docs/properties.md')

diff --git a/docs/properties.md b/docs/properties.md
new file mode 100644
index 0000000..1f62ff4
--- /dev/null
+++ b/docs/properties.md
@@ -0,0 +1,52 @@
+---
+title: Properties
+---
+
+# Properties
+
+Vim Vixen can be configured by defining settings in a JSON document, e.g.:
+
+```json
+{
+   "properties": {
+       "complete": "sbh"
+   }
+}
+```
+
+Properties can be temporarily overridden by using the `:set` command in the
+console.
+
+The following properties are available:
+
+## `smoothscroll`
+
+Enable/disable smooth scrolling.
+
+```
+:set smoothscroll   " enable smooth scrolling
+:set nosmoothscroll " disable smooth scrolling
+```
+
+## `hintchars`
+
+Set hint characters.
+
+```
+:set hintchars=0123456789
+```
+
+## `complete`
+
+Set completion items on `open`, `tabopen`, and `winopen` commands.
+The allowed value is character sequence of `s`, `b`, or `h`.
+Hit <kbd>Tab</kbd> or <kbd>Shift</kbd>+<kbd>Tab</kbd> to select an item from the completion list.
+Each character represents the following:
+
+- `s`: search engines
+- `b`: bookmark items
+- `h`: history items.
+
+```
+:set complete=sbh
+```
-- 
cgit v1.2.3