diff options
| author | skullY <skullydazed@gmail.com> | 2018-05-07 22:40:57 -0700 |
|---|---|---|
| committer | skullydazed <skullydazed@users.noreply.github.com> | 2018-05-07 22:46:26 -0700 |
| commit | 303f425c6b4f9ab6056f863e515c71c9325f2bfa (patch) | |
| tree | 150c9eba72bc40cf2d9a101d4a606156ea54cd0b /docs/documentation_best_practices.md | |
| parent | 9e5676650ec4ae71565201871c1aaf05e96a756b (diff) | |
| download | qmk_firmware-303f425c6b4f9ab6056f863e515c71c9325f2bfa.tar.gz qmk_firmware-303f425c6b4f9ab6056f863e515c71c9325f2bfa.zip | |
Fix up info boxes.
Diffstat (limited to 'docs/documentation_best_practices.md')
| -rw-r--r-- | docs/documentation_best_practices.md | 55 |
1 files changed, 11 insertions, 44 deletions
diff --git a/docs/documentation_best_practices.md b/docs/documentation_best_practices.md index 80de8c039..77c226117 100644 --- a/docs/documentation_best_practices.md +++ b/docs/documentation_best_practices.md | |||
| @@ -22,59 +22,26 @@ Your page should generally have multiple "H1" headings. Only H1 and H2 headings | |||
| 22 | 22 | ||
| 23 | You can have styled hint blocks drawn around text to draw attention to it. | 23 | You can have styled hint blocks drawn around text to draw attention to it. |
| 24 | 24 | ||
| 25 | ### Important | ||
| 26 | |||
| 25 | ``` | 27 | ``` |
| 26 | {% hint style='info' %} | 28 | !> This is important |
| 27 | This uses `hint style='info'` | ||
| 28 | {% endhint %} | ||
| 29 | ``` | 29 | ``` |
| 30 | 30 | ||
| 31 | ### Examples: | 31 | Renders as: |
| 32 | |||
| 33 | {% hint style='info' %} | ||
| 34 | This uses `hint style='info'` | ||
| 35 | {% endhint %} | ||
| 36 | |||
| 37 | {% hint style='tip' %} | ||
| 38 | This uses `hint style='tip'` | ||
| 39 | {% endhint %} | ||
| 40 | |||
| 41 | {% hint style='danger' %} | ||
| 42 | This uses `hint style='danger'` | ||
| 43 | {% endhint %} | ||
| 44 | 32 | ||
| 45 | {% hint style='working' %} | 33 | !> This is important |
| 46 | This uses `hint style='working'` | ||
| 47 | {% endhint %} | ||
| 48 | 34 | ||
| 49 | # Styled Terminal Blocks | 35 | ### General Tips |
| 50 | |||
| 51 | You can present styled terminal blocks by including special tokens inside your text block. | ||
| 52 | 36 | ||
| 53 | ``` | 37 | ``` |
| 54 | \`\`\` | 38 | ?> This is a helpful tip. |
| 55 | **[terminal] | ||
| 56 | **[prompt foo@joe]**[path ~]**[delimiter $ ]**[command ./myscript] | ||
| 57 | Normal output line. Nothing special here... | ||
| 58 | But... | ||
| 59 | You can add some colors. What about a warning message? | ||
| 60 | **[warning [WARNING] The color depends on the theme. Could look normal too] | ||
| 61 | What about an error message? | ||
| 62 | **[error [ERROR] This is not the error you are looking for] | ||
| 63 | \`\`\` | ||
| 64 | ``` | 39 | ``` |
| 65 | 40 | ||
| 66 | ### Example | 41 | Renders as: |
| 42 | |||
| 43 | ?> This is a helpful tip. | ||
| 67 | 44 | ||
| 68 | ``` | ||
| 69 | **[terminal] | ||
| 70 | **[prompt foo@joe]**[path ~]**[delimiter $ ]**[command ./myscript] | ||
| 71 | Normal output line. Nothing special here... | ||
| 72 | But... | ||
| 73 | You can add some colors. What about a warning message? | ||
| 74 | **[warning [WARNING] The color depends on the theme. Could look normal too] | ||
| 75 | What about an error message? | ||
| 76 | **[error [ERROR] This is not the error you are looking for] | ||
| 77 | ``` | ||
| 78 | 45 | ||
| 79 | # Documenting Features | 46 | # Documenting Features |
| 80 | 47 | ||
| @@ -94,4 +61,4 @@ This page describes my cool feature. You can use my cool feature to make coffee | |||
| 94 | |KC_SUGAR||Order Sugar| | 61 | |KC_SUGAR||Order Sugar| |
| 95 | ``` | 62 | ``` |
| 96 | 63 | ||
| 97 | Place your documentation into `docs/feature_<my_cool_feature>.md`, and add that file to the appropriate place in `docs/_summary.md`. If you have added any keycodes be sure to add them to `docs/keycodes.md` with a link back to your feature page. | 64 | Place your documentation into `docs/feature_<my_cool_feature>.md`, and add that file to the appropriate place in `docs/_sidebar.md`. If you have added any keycodes be sure to add them to `docs/keycodes.md` with a link back to your feature page. |
