import { _ as _imports_0$1 } from "./chunks/color-wheel.DIUCmfNZ.js"; import { _ as _export_sfc, D as resolveComponent, c as createElementBlock, I as createVNode, w as withCtx, a8 as createStaticVNode, o as openBlock, l as createBaseVNode } from "./chunks/framework.Clpp4x2N.js"; const _imports_0 = "/assets/badge-community-light.DoYC_YjC.svg"; const _imports_1 = "/assets/badge-community-dark.PWO_temo.svg"; const __pageData = JSON.parse('{"title":"Documentation Capabilities","description":"","frontmatter":{},"headers":[],"relativePath":"__capabilities.md","filePath":"__capabilities.md"}'); const _sfc_main = { name: "__capabilities.md" }; const _hoisted_1 = /* @__PURE__ */ createStaticVNode('

Documentation Capabilities ​

This page lays out the capabilities used by the QMK Firmware documentation, in order to aid future transitions to other page generators. Focuses mainly on things other than normal Markdown, as it's assumed that markdown generators should still function accordingly.

Overall capabilities ​

Unrelated to styling, high-level tech.

Dividing lines ​

Images ​

QMK Color Wheel with HSV Values

QMK LightQMK Dark

HSV Color Wheel

Lists ​

Newlines with <br>:

Line one
Line two
Line three

Nested dotted:

Nested dashed:

Nested numbered:

  1. The PR is complete and ready to merge
  2. GitHub checks for the PR are green whenever possible
    1. A "red" check may be disregarded by maintainers if the items flagged are unrelated to the change proposed in the PR
      1. Modifications to existing files should not need to add license headers to pass lint, for instance.
      2. If it's not directly related to your PR's functionality, prefer avoiding making a change.

Nested mixed:

  1. Add it to the schema in data/schemas/keyboards.jsonschema
  2. Add a mapping in data/maps
  3. (optional and discouraged) Add code to extract/generate it to:

Emoji ​

Direct: ​

👍🎉 First off, thanks for taking the time to read this and contribute! 🎉👍

As colon-name-colon: ​

✔️ : works and was tested

⭕ : does not apply

❌ : not supported by MCU

XML Entities ​

clueboard ← This is the organization folder, there's no rules.mk file

1–4

Command+`

Styling ​

CSS-ish ​

This is 150% of normal sizing, and bold!

Tables ​

Column AColumn B
LeftRight

Indented sections ​

Indent without any sort of marker

?> Query, this?

!> Notification, damnit!

INFO

This is an info box.

TIP

This is a tip.

WARNING

This is a warning.

DANGER

This is a dangerous warning.

Details

This is a details block.

Keyboard keys ​

,

Right Alt+Right Shift

  1. Click File > New > Makefile Project with Existing Code

  2. Click File > Preferences > > Settings

  3. Hit Ctrl-` (Grave) to bring up the terminal or go to View > Terminal (command workbench.action.terminal.toggleTerminal). A new terminal will be opened if there isn‘t one already.

    This should start the terminal in the workspace's folder (so the qmk_firmware folder), and then you can compile your keyboard.

Code Blocks ​

Inline code with tag: test

Inline code with backticks: test

This is preformatted\nIndented by 4 spaces\nThe letters lined up\n
c
int c_code(void) {\n    return -1;\n}
makefile
ifeq ($(BUILD),)\n     CHUNDER_REQUIRED = yes\nendif
python
from pathlib import Path\n\np = Path('/path/to/qmk_firmware')
json
{\n    "a": "b",\n    "c": 4,\n    "d": {\n        "e": [\n            0, 1, 2, 3\n        ]\n    }\n}
diff
 #undef RGBLIGHT_LED_COUNT\n+#undef RGBLIGHT_EFFECT_STATIC_GRADIENT\n+#undef RGBLIGHT_EFFECT_RAINBOW_SWIRL\n #define RGBLIGHT_LED_COUNT 12\n #define RGBLIGHT_HUE_STEP 8\n #define RGBLIGHT_SAT_STEP 8

Indented code as part of a list:

Sub/Superscript ​

This is subscripted, apparently.

This is superscripted, apparently.

I2C

T0H, T0L

Tabs ​

Tabs are based on section headers, with ** enclosing the tab title.

** Tab one ** ​

Content one

** Nested one ** ​

Nested content one

** Nested two ** ​

Nested content two

** Tab two ** ​

Content two

** Tab three ** ​

Content three

', 82); const _hoisted_83 = /* @__PURE__ */ createBaseVNode("p", null, "a content 2", -1); const _hoisted_84 = /* @__PURE__ */ createBaseVNode("p", null, "b content 2", -1); const _hoisted_85 = /* @__PURE__ */ createBaseVNode("p", null, "nested a content 2", -1); const _hoisted_86 = /* @__PURE__ */ createBaseVNode("p", null, "nested b content 2", -1); const _hoisted_87 = /* @__PURE__ */ createStaticVNode('

Details sections ​

Expandable:

Some summary text that shows up before expanding

!> Embedded notification!

This is some inner content.

Embed ​

example embed

Lorem ipsum dolor sit amet.

', 6); function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) { const _component_PluginTabsTab = resolveComponent("PluginTabsTab"); const _component_PluginTabs = resolveComponent("PluginTabs"); return openBlock(), createElementBlock("div", null, [ _hoisted_1, createVNode(_component_PluginTabs, null, { default: withCtx(() => [ createVNode(_component_PluginTabsTab, { label: "tab a" }, { default: withCtx(() => [ _hoisted_83 ]), _: 1 }), createVNode(_component_PluginTabsTab, { label: "tab b" }, { default: withCtx(() => [ _hoisted_84 ]), _: 1 }), createVNode(_component_PluginTabsTab, { label: "tab c" }, { default: withCtx(() => [ createVNode(_component_PluginTabs, null, { default: withCtx(() => [ createVNode(_component_PluginTabsTab, { label: "nested tab a" }, { default: withCtx(() => [ _hoisted_85 ]), _: 1 }), createVNode(_component_PluginTabsTab, { label: "nested tab b" }, { default: withCtx(() => [ _hoisted_86 ]), _: 1 }) ]), _: 1 }) ]), _: 1 }) ]), _: 1 }), _hoisted_87 ]); } const __capabilities = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]); export { __pageData, __capabilities as default };