diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2017-08-06 22:29:59 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-08-06 22:29:59 -0400 |
| commit | 9e79bb14915ee39b756eaeb569b14a54fb9916ec (patch) | |
| tree | 4a728db1c085614fb9197b8c0560a14954cffad7 /docs/documentation_best_practices.md | |
| parent | 1fc9eabd08136554e4f27f3d21cf5e002441abfe (diff) | |
| parent | 585f140052897dd0daa094e12fc725625340caa5 (diff) | |
Merge pull request #1554 from qmk/docs
Updates some remaining doc stuff
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 8c5b4795a6..f30793181c 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] +``` |