summaryrefslogtreecommitdiff
path: root/docs/documentation_best_practices.md
diff options
context:
space:
mode:
authorBalz Guenat2017-08-07 21:54:06 +0200
committerBalz Guenat2017-08-07 21:54:06 +0200
commitd18df8ef7a7e0528a29fdc96d4843ace54605121 (patch)
tree44f75b9bccd3efa130d622736726a5f1c83531f6 /docs/documentation_best_practices.md
parent308bec28bb76f4305d0f084252d7cf207f1b3d83 (diff)
parent933701c2129c0c585ecd8ba37c41b091a7dc687f (diff)
Merge remote-tracking branch 'upstream/master' into bananasplit
# Conflicts: # keyboards/bananasplit/Makefile # keyboards/bananasplit/bananasplit.c # keyboards/bananasplit/bananasplit.h # keyboards/bananasplit/config.h # keyboards/bananasplit/keymaps/default/keymap.c # keyboards/bananasplit/rules.mk
Diffstat (limited to 'docs/documentation_best_practices.md')
-rw-r--r--docs/documentation_best_practices.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/documentation_best_practices.md b/docs/documentation_best_practices.md
index 8c5b4795a..f30793181 100644
--- a/docs/documentation_best_practices.md
+++ b/docs/documentation_best_practices.md
@@ -22,6 +22,14 @@ Your page should generally have multiple "H1" headings. Only H1 and H2 headings
You can have styled hint blocks drawn around text to draw attention to it.
+```
+{% hint style='info' %}
+This uses `hint style='info'`
+{% endhint %}
+```
+
+### Examples:
+
{% hint style='info' %}
This uses `hint style='info'`
{% endhint %}
@@ -37,3 +45,33 @@ This uses `hint style='danger'`
{% hint style='working' %}
This uses `hint style='working'`
{% endhint %}
+
+# Styled Terminal Blocks
+
+You can present styled terminal blocks by including special tokens inside your text block.
+
+```
+\`\`\`
+**[terminal]
+**[prompt foo@joe]**[path ~]**[delimiter $ ]**[command ./myscript]
+Normal output line. Nothing special here...
+But...
+You can add some colors. What about a warning message?
+**[warning [WARNING] The color depends on the theme. Could look normal too]
+What about an error message?
+**[error [ERROR] This is not the error you are looking for]
+\`\`\`
+```
+
+### Example
+
+```
+**[terminal]
+**[prompt foo@joe]**[path ~]**[delimiter $ ]**[command ./myscript]
+Normal output line. Nothing special here...
+But...
+You can add some colors. What about a warning message?
+**[warning [WARNING] The color depends on the theme. Could look normal too]
+What about an error message?
+**[error [ERROR] This is not the error you are looking for]
+```