<spanclass="line"><span>This page covers my super cool feature. You can use this feature to make coffee, squeeze fresh oj, and have an egg mcmuffin and hashbrowns delivered from your local macca's by drone.</span></span></code></pre></div><h1id="headings"tabindex="-1">Headings <aclass="header-anchor"href="#headings"aria-label="Permalink to "Headings""></a></h1><p>Your page should generally have multiple "H1" headings. Only H1 and H2 headings will included in the Table of Contents, so plan them out appropriately. Excess width should be avoided in H1 and H2 headings to prevent the Table of Contents from getting too wide.</p><h1id="styled-hint-blocks"tabindex="-1">Styled Hint Blocks <aclass="header-anchor"href="#styled-hint-blocks"aria-label="Permalink to "Styled Hint Blocks""></a></h1><p>You can have styled hint blocks drawn around text to draw attention to it.</p><h3id="important"tabindex="-1">Important <aclass="header-anchor"href="#important"aria-label="Permalink to "Important""></a></h3><divclass="language- vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang"></span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><span>::: warning</span></span>
<spanclass="line"><span>This is important</span></span>
<spanclass="line"><span>:::</span></span></code></pre></div><p>Renders as:</p><divclass="warning custom-block"><pclass="custom-block-title">WARNING</p><p>This is important</p></div><h3id="general-tips"tabindex="-1">General Tips <aclass="header-anchor"href="#general-tips"aria-label="Permalink to "General Tips""></a></h3><divclass="language- vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang"></span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><span>::: tip</span></span>
<spanclass="line"><span>This is a helpful tip.</span></span>
<spanclass="line"><span>:::</span></span></code></pre></div><p>Renders as:</p><divclass="tip custom-block"><pclass="custom-block-title">TIP</p><p>This is a helpful tip.</p></div><h1id="documenting-features"tabindex="-1">Documenting Features <aclass="header-anchor"href="#documenting-features"aria-label="Permalink to "Documenting Features""></a></h1><p>If you create a new feature for QMK, create a documentation page for it. It doesn't have to be very long, a few sentences describing your feature and a table listing any relevant keycodes is enough. Here is a basic template:</p><divclass="language-markdown vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">markdown</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;--shiki-light-font-weight:bold;--shiki-dark-font-weight:bold;"># My Cool Feature</span></span>
<spanclass="line"></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">This page describes my cool feature. You can use my cool feature to make coffee and order cream and sugar to be delivered via drone.</span></span>
<spanclass="line"></span>
<spanclass="line"><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;--shiki-light-font-weight:bold;--shiki-dark-font-weight:bold;">## My Cool Feature Keycodes</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">|KC_SUGAR||Order Sugar|</span></span></code></pre></div><p>Place your documentation into <code>docs/features/<my_cool_feature>.md</code>, and add that file to the appropriate place in <code>docs/_sidebar.json</code>. If you have added any keycodes be sure to add them to <code>docs/keycodes.md</code> with a link back to your feature page.</p></div></div></main><footerclass="VPDocFooter"data-v-39a288b8data-v-09de1c0f><!--[--><!--]--><!----><navclass="prev-next"data-v-09de1c0f><divclass="pager"data-v-09de1c0f><aclass="VPLink link pager-link prev"href="/getting_started_make_guide"data-v-09de1c0f><!--[--><spanclass="desc"data-v-09de1c0f>Previous page</span><spanclass="title"data-v-09de1c0f>Make Documentation</span><!--]--></a></div><divclass="pager"data-v-09de1c0f><aclass="VPLink link pager-link next"href="/documentation_templates"data-v-09de1c0f><!--[--><spanclass="desc"data-v-09de1c0f>Next page</span><spanclass="title"data-v-09de1c0f>Documentation Templates</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
