mawww/kakoune
1
1
Fork 0
mirror of https://github.com/mawww/kakoune.git synced 2024-11-10 04:51:53 +03:00
Code Issues Projects Releases Wiki Activity

Merge branch 'doc_doc' of http://github.com/Pound-Hash/kakoune

Browse Source
This commit is contained in:
Maxime Coste 2022-05-09 20:04:53 +10:00
commit 7f245e92fb
1 changed files with 16 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
rc/tools/doc.asciidoc
View File

@ -3,32 +3,31 @@
This is Kakoune's online documentation system.
To see what documentation topics are available, type `:doc` and look at the
completion menu. To view the a particular documentation topic, type the topic
name or choose it from the completion menu and hit Enter.
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, <<doc#demonstration-target,like this>>. When you see a link, you can
follow it by moving the cursor onto it and pressing Enter. If the link takes you
to a different documentation topic, you can get back 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: <<doc#demonstration-target,like this>>. 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`,
and stored somewhere within <<doc#sources,the documentation search path>>.
Kakoune's built-in documentation renderer does not necessarily support every
feature, so don't go overboard with formatting.
Documentation must be in AsciiDoc format, with the extension `.asciidoc`.
It must be stored somewhere within <<doc#sources,the documentation search
path>>. 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-
name, just like `:doc` uses. Because topics are identified
only by their basename, you should take care that your topic's name does not
collide with any of the names used by other plugins or 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