mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-02-27 01:56:43 +00:00
65 lines
19 KiB
JavaScript
65 lines
19 KiB
JavaScript
|
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.DyMmIvSC.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('<h1 id="documentation-capabilities" tabindex="-1">Documentation Capabilities <a class="header-anchor" href="#documentation-capabilities" aria-label="Permalink to "Documentation Capabilities""></a></h1><p>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.</p><h2 id="overall-capabilities" tabindex="-1">Overall capabilities <a class="header-anchor" href="#overall-capabilities" aria-label="Permalink to "Overall capabilities""></a></h2><p>Unrelated to styling, high-level tech.</p><ul><li>Title anchors -- <code>:id=some-anchor-name</code>, used for direct linking to sections <ul><li>Links to anchors: <ul><li>Style 1: <a href="./platformdev_chibios_earlyinit?id=board-init">early initialization</a></li><li>Style 2: <a href="./platformdev_chibios_earlyinit#board-init">early initialization</a></li><li>Links to anchors on the same page, i.e. <a href="#emoji">Emoji</a></li></ul></li></ul></li><li>Specifying CNAME for root domain -- <code>docs.qmk.fm</code></li><li>Moved pages, see <code>index.html</code></li><li>Text search</li><li>Footnotes <a href="https://en.wikipedia.org/wiki/Eclipse_(software)" target="_blank" rel="noreferrer">like this</a></li></ul><h3 id="dividing-lines" tabindex="-1">Dividing lines <a class="header-anchor" href="#dividing-lines" aria-label="Permalink to "Dividing lines""></a></h3><hr><hr><hr><h3 id="images" tabindex="-1">Images <a class="header-anchor" href="#images" aria-label="Permalink to "Images""></a></h3><p><img src="https://i.imgur.com/vkYVo66.jpg" alt="QMK Color Wheel with HSV Values"></p><p><img src="' + _imports_0 + '" alt="QMK Light"><img src="' + _imports_1 + '" alt="QMK Dark"></p><img src="' + _imports_0$1 + '" alt="HSV Color Wheel" width="250"><h3 id="lists" tabindex="-1">Lists <a class="header-anchor" href="#lists" aria-label="Permalink to "Lists""></a></h3><p>Newlines with <code><br></code>:</p><p>Line one<br> Line two<br> Line three</p><p>Nested dotted:</p><ul><li>The PR is complete and ready to merge</li><li>GitHub checks for the PR are green whenever possible <ul><li>A "red" check may be disregarded by maintainers if the items flagged are unrelated to the change proposed in the PR <ul><li>Modifications to existing files should not need to add license headers to pass lint, for instance.</li><li>If it's not directly related to your PR's functionality, prefer avoiding making a change.</li></ul></li></ul></li></ul><p>Nested dashed:</p><ul><li>The PR is complete and ready to merge</li><li>GitHub checks for the PR are green whenever possible <ul><li>A "red" check may be disregarded by maintainers if the items flagged are unrelated to the change proposed in the PR <ul><li>Modifications to existing files should not need to add license headers to pass lint, for instance.</li><li>If it's not directly related to your PR's functionality, prefer avoiding making a change.</li></ul></li></ul></li></ul><p>Nested numbered:</p><ol><li>The PR is complete and ready to merge</li><li>GitHub checks for the PR are green whenever possible <ol><li>A "red" check may be disregarded by maintainers if the items flagged are unrelated to the change proposed in the PR <ol><li>Modifications to existing files should not need to add license headers to pass lint, for instance.</li><li>If it's not directly related to your PR's functionality, prefer avoiding making a change.</li></ol></li></ol></li></ol><p>Nested mixed:</p><ol><li>Add it to the schema in <code>data/schemas/keyboards.jsonschema</code></li><li>Add a mapping in <code>data/maps</code></li><li>(optional and discouraged) Add code to extract/generate it to:</li></ol><ul><li><code>lib/python/qmk/info.py</code></li><li><code>lib/python/qmk/cli/generate/config_h.py</code></li><li
|
|||
|
|
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('<h2 id="details-sections" tabindex="-1">Details sections <a class="header-anchor" href="#details-sections" aria-label="Permalink to "Details sections""></a></h2><p>Expandable:</p><details><summary>Some summary text that shows up before expanding</summary><p>!> Embedded notification!</p><p>This is some inner content.</p></details><h2 id="embed" tabindex="-1">Embed <a class="header-anchor" href="#embed" aria-label="Permalink to "Embed""></a></h2><p><a href="./__capabilities_inc" title=":include">example embed</a></p><p>Lorem ipsum dolor sit amet.</p>', 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
|
|||
|
|
};
|