diff options
| author | Nick Brassel <nick@tzarc.org> | 2024-05-30 12:00:41 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-30 12:00:41 +1000 |
| commit | 6ef97172889ccd5db376b2a9f8825489e24fdac4 (patch) | |
| tree | 334e3bf41c8554d4bee73a140822f95f60eb64e9 /docs/documentation_best_practices.md | |
| parent | 395766657ff98a4b1fd0dcba5917557f8acbb9e4 (diff) | |
Vitepress conversion of docs. (#23795)
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. | |||
| 25 | ### Important | 25 | ### Important |
| 26 | 26 | ||
| 27 | ``` | 27 | ``` |
| 28 | !> This is important | 28 | ::: warning |
| 29 | This is important | ||
| 30 | ::: | ||
| 29 | ``` | 31 | ``` |
| 30 | 32 | ||
| 31 | Renders as: | 33 | Renders as: |
| 32 | 34 | ||
| 33 | !> This is important | 35 | ::: warning |
| 36 | This is important | ||
| 37 | ::: | ||
| 34 | 38 | ||
| 35 | ### General Tips | 39 | ### General Tips |
| 36 | 40 | ||
| 37 | ``` | 41 | ``` |
| 38 | ?> This is a helpful tip. | 42 | ::: tip |
| 43 | This is a helpful tip. | ||
| 44 | ::: | ||
| 39 | ``` | 45 | ``` |
| 40 | 46 | ||
| 41 | Renders as: | 47 | Renders as: |
| 42 | 48 | ||
| 43 | ?> This is a helpful tip. | 49 | ::: tip |
| 50 | This is a helpful tip. | ||
| 51 | ::: | ||
| 44 | 52 | ||
| 45 | 53 | ||
| 46 | # Documenting Features | 54 | # Documenting Features |
| @@ -61,4 +69,4 @@ This page describes my cool feature. You can use my cool feature to make coffee | |||
| 61 | |KC_SUGAR||Order Sugar| | 69 | |KC_SUGAR||Order Sugar| |
| 62 | ``` | 70 | ``` |
| 63 | 71 | ||
| 64 | 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. | 72 | 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. |
