Update documentation
authorMikael Berthe <mikael@lilotux.net>
Sun, 21 May 2017 12:31:06 +0200
changeset 143 abfa3aa97b51
parent 142 b0d55f7fddeb
child 144 15ecc49bbb25
Update documentation
configuration.md
templates/README.md
--- a/configuration.md	Sun May 14 16:27:33 2017 +0200
+++ b/configuration.md	Sun May 21 12:31:06 2017 +0200
@@ -51,6 +51,9 @@
 madonctl -i mastodon.social code $CODE > config_file.yaml
 ```
 
+Note that if you have set up madonctl to use a default theme, you will have
+to force the output with `-o plain` to get the example configuration file.
+
 ## Settings
 
 All the available settings should be displayed with *config dump* (assuming
--- a/templates/README.md	Sun May 14 16:27:33 2017 +0200
+++ b/templates/README.md	Sun May 21 12:31:06 2017 +0200
@@ -31,6 +31,9 @@
 Currently, if a template is missing, madonctl will fall back to the _plain_
 output format.  (In the future it might just fail with an error message.)
 
+You can set up madonctl so that a theme is used by default.  See the
+[configuration](../configuration.md) page for details.
+
 ## Templates
 
 Here's an example using a template with ANSI color escape codes (for UNIX/Linux):
@@ -39,19 +42,20 @@
 
 ### Template development
 
-Here's a list of available commands (please check the Go template documentation for the built-in functions):
+Here's a list of available commands (please check the Go template documentation
+for the built-in functions):
 
 Function | Description
 -------- | -----------
-fromunix UNIXTIMESTAMP  | converts from UNIX timestampto date
-tolocal TEXTRFC3339DATE | converts a RFC3339 date string to a local time
-fromhtml HTMLTEXT       | converts HTML to plain text
-wrap TEXT       | rewrap text, with indent and max width
-trim TEXT       | trims text whitespace
-color COLORSPEC | sends an ANSI color code sequence
+`fromunix UNIXTIMESTAMP`  | converts from UNIX timestampto date
+`tolocal TEXTRFC3339DATE` | converts a RFC3339 date string to a local time
+`fromhtml HTMLTEXT`       | converts HTML to plain text
+`wrap TEXT`       | rewrap text, with indent and max width
+`trim TEXT`       | trims text whitespace
+`color COLORSPEC` | sends an ANSI color code sequence
 
-*COLORSPEC* is a string with the following format:
-`[FGCOLOR][,BGCOLOR[,STYLE]]` or `reset`.
+*COLORSPEC* is a string with the following format: `[FGCOLOR][,BGCOLOR[,STYLE]]`
+or `reset`.
 
 Examples: