xenia/kakoune
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Wrapped the lines at the 80th column

Browse Source
This commit is contained in:
Pound_Hash 2022-05-06 10:33:12 -07:00
parent 0ba945d585
commit ac5ebe70ae
1 changed files with 16 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
rc/tools/doc.asciidoc
View File

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