keyboard/qmk-keychron-q3-colemak-dh
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Vitepress conversion of docs. (#23795)

Browse Source
This commit is contained in:
Nick Brassel
2024-05-30 12:00:41 +10:00
committed by GitHub
parent 395766657f
commit 6ef9717288
357 changed files with 3611 additions and 24208 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/documentation_best_practices.md
View File

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