Mercurial > irccd
changeset 276:5795a1769de5
Docs: add more indexes
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Thu, 29 Sep 2016 13:09:58 +0200 |
| parents | c143682678b9 |
| children | 685a492c39ba |
| files | doc/html/CMakeLists.txt doc/html/build/index.md doc/html/dev/index.md doc/html/index.md doc/html/irccd/index.md doc/html/irccdctl/index.md doc/html/misc/configuration-syntax.md doc/html/misc/index.md |
| diffstat | 8 files changed, 68 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/html/CMakeLists.txt Thu Sep 29 12:41:19 2016 +0200 +++ b/doc/html/CMakeLists.txt Thu Sep 29 13:09:58 2016 +0200 @@ -137,15 +137,20 @@ ${html_SOURCE_DIR}/api/event/onQuery.md ${html_SOURCE_DIR}/build/build-from-sources.md ${html_SOURCE_DIR}/build/build-options.md + ${html_SOURCE_DIR}/build/index.md + ${html_SOURCE_DIR}/dev/index.md ${html_SOURCE_DIR}/dev/plugin-javascript-introduction.md ${html_SOURCE_DIR}/dev/socket-commands.md ${html_SOURCE_DIR}/dev/socket-protocol.md ${html_SOURCE_DIR}/irccd/configuring.md + ${html_SOURCE_DIR}/irccd/index.md ${html_SOURCE_DIR}/irccdctl/commands.md ${html_SOURCE_DIR}/irccdctl/configuring.md + ${html_SOURCE_DIR}/irccdctl/index.md ${html_SOURCE_DIR}/irccdctl/usage.md ${html_SOURCE_DIR}/misc/common-patterns-and-formatting.md ${html_SOURCE_DIR}/misc/configuration-syntax.md + ${html_SOURCE_DIR}/misc/index.md ) set(
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/build/index.md Thu Sep 29 13:09:58 2016 +0200 @@ -0,0 +1,8 @@ +--- +title: "Building" +header: "Building" +guide: yes +--- + +- [Build from sources](build/build-from-sources.html) +- [Build options](build/build-options.html)
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/dev/index.md Thu Sep 29 13:09:58 2016 +0200 @@ -0,0 +1,9 @@ +--- +title: "Development" +header: "Development" +guide: yes +--- + + - [Javascript plugin introduction](plugin-javascript-introduction.html) + - [Network protocol](socket-protocol.html) + - [Network commands](socket-commands.html)
--- a/doc/html/index.md Thu Sep 29 12:41:19 2016 +0200 +++ b/doc/html/index.md Thu Sep 29 13:09:58 2016 +0200 @@ -1,5 +1,5 @@ --- -header: Irccd documentation +header: "Irccd documentation" guide: true --- @@ -7,22 +7,40 @@ # Building +Everything you need to build irccd. + - [Build from sources](build/build-from-sources.html) - [Build options](build/build-options.html) # Running +Running irccd, configuration and command line options. + - [Configure irccd](irccd/configuring.html) + +And about irccdctl. + - [Configure irccdctl](irccdctl/configuring.html) + - [List of irccdctl commands](irccdctl/commands.html) + - [Irccdctl command line usage](irccdctl/usage.html) -# Plugins +# Development + +Development of plugins and other development documentation. - [Javascript plugin introduction](dev/plugin-javascript-introduction.html) + - [Network protocol](dev/socket-protocol.html) + - [Network commands](dev/socket-commands.html) + +# Plugin API + +The official Javascript API. + - [Javascript API](api/index.html) # Miscellaneous +Miscellaneous documentation. + - [Common patterns and formatting](misc/common-patterns-and-formatting.html) - [Configuration file syntax](misc/configuration-syntax.html) - - [Network protocol](dev/socket-protocol.html) - - [Network commands](dev/socket-commands.html)
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccd/index.md Thu Sep 29 13:09:58 2016 +0200 @@ -0,0 +1,7 @@ +--- +title: "Irccd" +header: "Irccd" +guide: yes +--- + + - [Configure irccd](configuring.html)
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/irccdctl/index.md Thu Sep 29 13:09:58 2016 +0200 @@ -0,0 +1,9 @@ +--- +title: "Irccdctl" +header: "Irccdctl" +guide: yes +--- + + - [Configure irccdctl](configuring.html) + - [List of irccdctl commands](commands.html) + - [Irccdctl command line usage](usage.html)
--- a/doc/html/misc/configuration-syntax.md Thu Sep 29 12:41:19 2016 +0200 +++ b/doc/html/misc/configuration-syntax.md Thu Sep 29 13:09:58 2016 +0200 @@ -1,7 +1,6 @@ --- title: Configuration file format guide: yes -toc: yes --- Both `irccd` and `irccdctl` use configuration file in a extended [INI][ini] format.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/misc/index.md Thu Sep 29 13:09:58 2016 +0200 @@ -0,0 +1,8 @@ +--- +title: "Miscellaneous" +header: "Miscellaneous" +guide: yes +--- + + - [Common patterns and formatting](common-patterns-and-formatting.html) + - [Configuration file syntax](configuration-syntax.html)