diff --git a/rc/tools/doc.asciidoc b/rc/tools/doc.asciidoc index 30d99343..bb2e262b 100644 --- a/rc/tools/doc.asciidoc +++ b/rc/tools/doc.asciidoc @@ -2,35 +2,32 @@ This is Kakoune's online documentation system. -To see what documentation topics are available, -type `:doc` and look at the completion menu. -To view a particular topic, -type its name or select it from the completion menu. -Then hit Enter. +To see what documentation topics are available, type `:doc` and look at the +completion menu. To view a particular topic, type its name or select it +from the completion menu. Then hit Enter. Documentation will be displayed in the client named in the `docsclient` option. == Using the documentation browser -Documentation buffers are like any other buffer, -so you can scroll through them as normal, -search within a topic with `/`, etc. -However, they can also contain links: <>. -Links can be followed by moving the cursor onto them and pressing Enter. -If a link takes you to a different documentation topic, -you can return to the original by using the `:buffer` command. +Documentation buffers are like any other buffer, so you can scroll through +them as normal, search within a topic with `/`, etc. However, they can also +contain links: <>. Links can be followed +by moving the cursor onto them and pressing Enter. If a link takes you to +a different documentation topic, you can return to the original by using the +`:buffer` command. == Writing documentation Documentation must be in AsciiDoc format, with the extension `.asciidoc`. -It must be stored somewhere within <>. -Kakoune's built-in documentation renderer does not necessarily support every feature, -so don't go overboard with formatting. +It must be stored somewhere within <>. Kakoune's built-in documentation renderer does not necessarily +support every feature, so don't go overboard with formatting. -To create a link to another documentation topic, -the URL should be the topic's name, just like `:doc` uses. -Because topics are identified only by their basename, -you should take care that your topic's name does not conflict with any of the names used either by other plugins or by Kakoune's standard library. +To create a link to another documentation topic, the URL should be the topic's +name, just like `:doc` uses. Because topics are identified only by their +basename, you should take care that your topic's name does not conflict with +any of the names used either by other plugins or by Kakoune's standard library. == Sources