summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMaxime Coste <mawww@kakoune.org>2017-11-08 16:32:49 +0800
committerMaxime Coste <mawww@kakoune.org>2017-11-08 16:32:49 +0800
commitb63f16e7a23a9954cd62046ff40efd5f7cf4d263 (patch)
tree84a11b732e70c65e1d1469f4b58f1ee74624006b /doc
parent1fe9db3c307a98034a3a12ac57979d7edf07cebc (diff)
doc.kak: Support anchors and internal links
Underline links, support jumping to a specific anchor either in the current page or another one, use those new features in some pages.
Diffstat (limited to 'doc')
-rw-r--r--doc/pages/commands.asciidoc11
-rw-r--r--doc/pages/options.asciidoc4
2 files changed, 10 insertions, 5 deletions
diff --git a/doc/pages/commands.asciidoc b/doc/pages/commands.asciidoc
index 588a7543..ea4bf9e5 100644
--- a/doc/pages/commands.asciidoc
+++ b/doc/pages/commands.asciidoc
@@ -82,7 +82,8 @@ command *q!* has to be used). Aliases are mentionned below each commands.
show *text* in status line, with the following *options*:
*-markup*:::
- expand the markup strings in *text* (See <<expansions#,`:doc expansions`>>)
+ expand the markup strings in *text* (See
+ <<expansions#Markup strings,`:doc expansions 'Markup strings'`>>)
*-debug*:::
print the given text to the *\*debug** buffer
@@ -96,7 +97,7 @@ command *q!* has to be used). Aliases are mentionned below each commands.
*declare-option* [-hidden] <type> <name> [<value>]::
*alias* decl +
declare a new option, the -hidden hides the option in completion
- suggestions (See <<options#,`:doc options`>>)
+ suggestions (See <<options#declare-option,`:doc options declare-option`>>)
*set-option* <scope> <name> <value>::
*alias* set +
@@ -105,15 +106,15 @@ command *q!* has to be used). Aliases are mentionned below each commands.
target *scope* is 'buffer', e.g. set buffer=/path/to/buffer foo "bar";
the scope can also take the `current` special value, which will automatically
point to the narrowest scope available in the current context
- (See <<options#,`:doc options`>>)
+ (See <<options#set-option,`:doc options set-option`>>)
*unset-option* <scope> <name>::
*alias* unset +
- unset the value of an option (See <<options#,`:doc options`>>)
+ unset the value of an option (See <<options#unset-option,`:doc options unset-option`>>)
*update-option* <scope> <name>::
update the value of an option if its type supports that operation
- (See <<options#,`:doc options`>>)
+ (See <<options#update-option,`:doc options update-option`>>)
*alias* <scope> <name> <command>::
define a new alias, within the context of a scope
diff --git a/doc/pages/options.asciidoc b/doc/pages/options.asciidoc
index 0d470b01..0398af30 100644
--- a/doc/pages/options.asciidoc
+++ b/doc/pages/options.asciidoc
@@ -6,6 +6,7 @@ Kakoune can store named and typed values that can be used both to
customize the core editor behaviour, and to store data used by extension
scripts.
+[[set-option]]
Options can be modified using the `set-option` command:
---------------------------------
@@ -16,6 +17,7 @@ set-option <scope> <name> <value>
<<scopes#,`:doc scopes`>>). *current* relate to the narrowest scope in
which the option is already set.
+[[unset-option]]
Options values can be unset in a specific scope with the `unset-option`
command:
@@ -26,6 +28,7 @@ unset-option <scope> <name>
Unsetting an option will make it fallback to the value of its parent mode,
hence options cannot be unset from the *global* scope.
+[[declare-option]]
New options can be declared using the `declare-option` command:
------------------------------------------------
@@ -35,6 +38,7 @@ declare-option [-hidden] <type> <name> [<value>]
If `-hidden` is specified, the option will not be displayed in completion
suggestions.
+[[update-option]]
Certain option type can be *updated*, usually to match potential changes
in the buffer they relate to. This can be triggered by the `update-option`
command: