mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-07-18 21:52:02 +00:00
16 lines
5.3 KiB
JavaScript
16 lines
5.3 KiB
JavaScript
import { _ as _export_sfc, c as createElementBlock, o as openBlock, a8 as createStaticVNode } from "./chunks/framework.Cauyuiy8.js";
|
||
const __pageData = JSON.parse('{"title":"Documentation Templates","description":"","frontmatter":{},"headers":[],"relativePath":"documentation_templates.md","filePath":"documentation_templates.md","lastUpdated":null}');
|
||
const _sfc_main = { name: "documentation_templates.md" };
|
||
const _hoisted_1 = /* @__PURE__ */ createStaticVNode('<h1 id="documentation-templates" tabindex="-1">Documentation Templates <a class="header-anchor" href="#documentation-templates" aria-label="Permalink to "Documentation Templates""></a></h1><p>This page documents the templates you should use when submitting new Keymaps and Keyboards to QMK.</p><h2 id="keyboard-readmemd-template" tabindex="-1">Keymap <code>readme.md</code> Template <a class="header-anchor" href="#keyboard-readmemd-template" aria-label="Permalink to "Keymap `readme.md` Template {#keyboard-readmemd-template}""></a></h2><p>Most keymaps have an image depicting the layout. You can use <a href="http://keyboard-layout-editor.com" target="_blank" rel="noreferrer">Keyboard Layout Editor</a> to create an image. Upload it to <a href="https://imgur.com" target="_blank" rel="noreferrer">Imgur</a> or another hosting service, please do not include images in your Pull Request.</p><p>Below the image you should write a short description to help people understand your keymap.</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span></span></span>\n<span class="line"><span></span></span>\n<span class="line"><span># Default Clueboard Layout</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>This is the default layout that comes flashed on every Clueboard. For the most</span></span>\n<span class="line"><span>part it's a straightforward and easy to follow layout. The only unusual key is</span></span>\n<span class="line"><span>the key in the upper left, which sends Escape normally, but Grave when any of</span></span>\n<span class="line"><span>the Ctrl, Alt, or GUI modifiers are held down.</span></span></code></pre></div><h2 id="keyboard-readme-md-template" tabindex="-1">Keyboard <code>readme.md</code> Template <a class="header-anchor" href="#keyboard-readme-md-template" aria-label="Permalink to "Keyboard `readme.md` Template""></a></h2><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span># Planck</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span></span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>A compact 40% (12x4) ortholinear keyboard kit made and sold by OLKB and Massdrop. [More info on qmk.fm](https://qmk.fm/planck/)</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>* Keyboard Maintainer: [Jack Humbert](https://github.com/jackhumbert)</span></span>\n<span class="line"><span>* Hardware Supported: Planck PCB rev1, rev2, rev3, rev4, Teensy 2.0</span></span>\n<span class="line"><span>* Hardware Availability: [OLKB.com](https://olkb.com), [Massdrop](https://www.massdrop.com/buy/planck-mechanical-keyboard?mode=guest_open)</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>Make example for this keyboard (after setting up your build environment):</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span> make planck/rev4:default</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>Flashing example for this keyboard:</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span> make planck/rev4:default:flash</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>See the [build environment setup](getting_started_build_tools) and the [make instructions](getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](newbs).</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>## Bootloader</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>Enter the bootloader in 3 ways:</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard</span></span>\n<span class="line"><span>* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead</span></span>\n<span class="line"><span>* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available</span></span></code></pre></div>', 8);
|
||
const _hoisted_9 = [
|
||
_hoisted_1
|
||
];
|
||
function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
|
||
return openBlock(), createElementBlock("div", null, _hoisted_9);
|
||
}
|
||
const documentation_templates = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
|
||
export {
|
||
__pageData,
|
||
documentation_templates as default
|
||
};
|