Mercurial > irccd
diff plugins/joke/joke.md @ 817:ebe561276c33
doc: start reworking, continue #752 @8h
author | David Demelier <markand@malikania.fr> |
---|---|
date | Mon, 19 Nov 2018 07:04:42 +0100 |
parents | 5afc0b3a9ad8 |
children |
line wrap: on
line diff
--- a/plugins/joke/joke.md Fri Nov 16 20:16:00 2018 +0100 +++ b/plugins/joke/joke.md Mon Nov 19 07:04:42 2018 +0100 @@ -1,8 +1,4 @@ ---- -title: "Joke plugin" -header: "Joke plugin" -guide: yes ---- +# Joke plugin The plugin **joke** is a convenient command to display jokes in a random order without displaying always the same. @@ -10,7 +6,7 @@ It loads jokes per channel/server pair and display a unique joke each time it is invoked. -# Installation +## Installation The plugin **joke** is distributed with irccd. To enable it add the following to your `plugins` section: @@ -56,8 +52,8 @@ The following options are available under the `[plugin.history]` section: - - **file**: (string) path to the JSON jokes files (Optional: defaults to data - directory/jokes.json) +- **file**: (string) path to the JSON jokes files (Optional: defaults to data + directory/jokes.json) ### Keywords supported @@ -74,7 +70,7 @@ The **joke** plugin supports the following formats in `[format.joke]` section: - - **error**: (string) format when an internal error occured. +- error: (string) format when an internal error occured. ### Keywords supported