Fix up info boxes.

[qmk_firmware.git] / docs / documentation_best_practices.md

diff --git a/docs/documentation_best_practices.md b/docs/documentation_best_practices.md
index 80de8c039a95dfe3b4785ba5ed834e1c45c3ae17..77c226117c2d95eb8fcbb27bd8a4cdd355ae2558 100644 (file)
--- 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
 
 You can have styled hint blocks drawn around text to draw attention to it.
 
 
 You can have styled hint blocks drawn around text to draw attention to it.
 

+### Important
+

 ```
 ```

-{% hint style='info' %}
-This uses `hint style='info'`
-{% endhint %}
+!> This is important

 ```
 
 ```
 

-### Examples:
-
-{% hint style='info' %}
-This uses `hint style='info'`
-{% endhint %}
-
-{% hint style='tip' %}
-This uses `hint style='tip'`
-{% endhint %}
-
-{% hint style='danger' %}
-This uses `hint style='danger'`
-{% endhint %}
+Renders as:

 
 

-{% hint style='working' %}
-This uses `hint style='working'`
-{% endhint %}
+!> This is important

 
 

-# Styled Terminal Blocks
-
-You can present styled terminal blocks by including special tokens inside your text block.
+### General Tips

 
 ```
 
 ```

-\`\`\`
-**[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]
-\`\`\`
+?> This is a helpful tip.

 ```
 
 ```
 

-### Example
+Renders as:
+
+?> This is a helpful tip.

 
 

-```
-**[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]
-```

 
 # Documenting Features
 
 
 # Documenting Features
 


@@ -94,4 +61,4 @@ This page describes my cool feature. You can use my cool feature to make coffee
 |KC_SUGAR||Order Sugar|
 ```
 
 |KC_SUGAR||Order Sugar|
 ```
 

-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.
+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.