Minor documentation updates
authorMikael Berthe <mikael@lilotux.net>
Sun, 07 May 2017 23:22:28 +0200
changeset 98 dd260cff924e
parent 97 ce979580711a
child 99 a179dc99a044
Minor documentation updates
README.md
templates/README.md
--- a/README.md	Sun May 07 22:07:58 2017 +0200
+++ b/README.md	Sun May 07 23:22:28 2017 +0200
@@ -171,7 +171,7 @@
 concurrent hashtags is currently limited to 4 for "politeness".
 
 
-(Almost) All commands have a customisable outpput
+(Almost) All commands have a customisable output:
 ``` sh
 % madonctl accounts show            # Display an account
 % madonctl accounts show -o yaml    # Display an account, in yaml
--- a/templates/README.md	Sun May 07 22:07:58 2017 +0200
+++ b/templates/README.md	Sun May 07 23:22:28 2017 +0200
@@ -13,10 +13,9 @@
 (unless they are absolute paths or start with "./" or "../").
 
 The themes are located in the `themes` directory, inside the base template
-directory.
+directory (e.g. `$template_directory/themes/ansi/`).
 A theme is a collection of templates grouped in a theme directory (the name of
-the directory is the name of the theme).\
-E.g. `$template_directory/themes/ansi/`
+the directory is the name of the theme).
 
 ## Themes
 
@@ -45,16 +44,18 @@
 - fromhtml HTMLTEXT
 - wrap TEXT
 - trim TEXT
-- color COLORSPEC
+- color COLORSPEC\
   COLORSPEC is a string with the following format: `[FGCOLOR][,BGCOLOR[,STYLE]]` or `reset`.
 
-  Examples:
+Examples:
 
-    {{color "red"}}red text{{color "reset"}}
-    {{color ",red"}}red background{{color "reset"}}
-    {{color "white,,bold"}}bright white text{{color "reset"}}
+```
+  {{color "red"}}red text{{color "reset"}}
+  {{color ",red"}}red background{{color "reset"}}
+  {{color "white,,bold"}}bright white text{{color "reset"}}
 
-    Message: {{color "blue"}}{{.content | fromhtml | wrap "    " 80 | trim}}{{color "reset"}}
+  Message: {{color "blue"}}{{.content | fromhtml | wrap "    " 80 | trim}}{{color "reset"}}
+```
 
 Note that the _wrap_ implementation might change in the future; currently it is
 paragraph-based, not line-based, and the result can be surprising after