diff options
author | QMK Bot <[email protected]> | 2024-05-30 02:01:09 +0000 |
---|---|---|
committer | QMK Bot <[email protected]> | 2024-05-30 02:01:09 +0000 |
commit | 47356b220101b4f5b8ca71b2e1aa4f04256dd60f (patch) | |
tree | 7cf20bd01edf0285053cd9548944fd4133a27567 /docs/documentation_best_practices.md | |
parent | b36c7b99ae57e8d848373f44755510308c4eefa3 (diff) | |
parent | 6ef97172889ccd5db376b2a9f8825489e24fdac4 (diff) | |
download | qmk_firmware-47356b220101b4f5b8ca71b2e1aa4f04256dd60f.tar.gz qmk_firmware-47356b220101b4f5b8ca71b2e1aa4f04256dd60f.zip |
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs/documentation_best_practices.md')
-rw-r--r-- | docs/documentation_best_practices.md | 18 |
1 files changed, 13 insertions, 5 deletions
diff --git a/docs/documentation_best_practices.md b/docs/documentation_best_practices.md index c193fed6b8..d41ec28f19 100644 --- a/docs/documentation_best_practices.md +++ b/docs/documentation_best_practices.md @@ -25,22 +25,30 @@ You can have styled hint blocks drawn around text to draw attention to it. ### Important ``` -!> This is important +::: warning +This is important +::: ``` Renders as: -!> This is important +::: warning +This is important +::: ### General Tips ``` -?> This is a helpful tip. +::: tip +This is a helpful tip. +::: ``` Renders as: -?> This is a helpful tip. +::: tip +This is a helpful tip. +::: # Documenting Features @@ -61,4 +69,4 @@ This page describes my cool feature. You can use my cool feature to make coffee |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.json`. If you have added any keycodes be sure to add them to `docs/keycodes.md` with a link back to your feature page. |