diff options
author | That-Canadian <poole.chris.11@gmail.com> | 2017-08-07 08:00:02 -0400 |
---|---|---|
committer | That-Canadian <poole.chris.11@gmail.com> | 2017-08-07 08:00:02 -0400 |
commit | 1bbb49585ee1aef347b7c3397bc9f83040289402 (patch) | |
tree | 21bb9b3fb5c266ce786b250d2004730fd1df5ece /docs/documentation_best_practices.md | |
parent | 15822a8e44a4d3d02ae5d5e9deedd27ffc2c6709 (diff) | |
parent | 597ff7aee9a04b4f4f41d6d1f5b2e1223e0e83b8 (diff) | |
download | firmware-1bbb49585ee1aef347b7c3397bc9f83040289402.tar.gz firmware-1bbb49585ee1aef347b7c3397bc9f83040289402.tar.bz2 firmware-1bbb49585ee1aef347b7c3397bc9f83040289402.zip |
Merge branch 'master' into minidox
Diffstat (limited to 'docs/documentation_best_practices.md')
-rw-r--r-- | docs/documentation_best_practices.md | 38 |
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] +``` |