mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-02-27 01:56:43 +00:00
16 lines
52 KiB
JavaScript
16 lines
52 KiB
JavaScript
|
import { _ as _export_sfc, c as createElementBlock, o as openBlock, a8 as createStaticVNode } from "./chunks/framework.DyMmIvSC.js";
|
|||
|
|
const __pageData = JSON.parse('{"title":"info.json Reference","description":"","frontmatter":{},"headers":[],"relativePath":"reference_info_json.md","filePath":"reference_info_json.md"}');
|
|||
|
|
const _sfc_main = { name: "reference_info_json.md" };
|
|||
|
|
const _hoisted_1 = /* @__PURE__ */ createStaticVNode('<h1 id="info-json-reference" tabindex="-1"><code>info.json</code> Reference <a class="header-anchor" href="#info-json-reference" aria-label="Permalink to "`info.json` Reference {#info-json-reference}""></a></h1><p>The information contained in <code>info.json</code> is combined with the <code>config.h</code> and <code>rules.mk</code> files, dynamically generating the necessary configuration for your keyboard at compile time. It is also used by the <a href="https://github.com/qmk/qmk_api" target="_blank" rel="noreferrer">QMK API</a>, and contains the information <a href="https://config.qmk.fm/" target="_blank" rel="noreferrer">QMK Configurator</a> needs to display a representation of your keyboard. Its key/value pairs are ruled by the <a href="https://github.com/qmk/qmk_firmware/blob/master/data/schemas/keyboard.jsonschema" target="_blank" rel="noreferrer"><code>data/schemas/keyboard.jsonschema</code></a> file. To learn more about the why and how of the schema file see the <a href="./data_driven_config">Data Driven Configuration</a> page.</p><p>You can create <code>info.json</code> files at every level under <code>qmk_firmware/keyboards/<keyboard_name></code>. These files are combined, with more specific files overriding keys in less specific files. This means you do not need to duplicate your metadata information. For example, <code>qmk_firmware/keyboards/clueboard/info.json</code> specifies information common to all Clueboard products, such as <code>manufacturer</code> and <code>maintainer</code>, while <code>qmk_firmware/keyboards/clueboard/66/info.json</code> contains more specific information about Clueboard 66%.</p><h2 id="general-metadata" tabindex="-1">General Metadata <a class="header-anchor" href="#general-metadata" aria-label="Permalink to "General Metadata {#general-metadata}""></a></h2><ul><li><code>keyboard_name</code> (Required) <ul><li>A free-form text string describing the keyboard. This will be used as the USB product string. Can include Unicode characters, escaped to ASCII eg. <code>\\u03A8</code> (Ψ).</li><li>Example: <code>"Clueboard 66%"</code></li></ul></li><li><code>maintainer</code> (Required) <ul><li>GitHub username of the maintainer, or <code>qmk</code> for community maintained boards.</li><li>Example: <code>"skullydazed"</code></li></ul></li><li><code>manufacturer</code> (Required) <ul><li>A free-form text string describing the keyboard's manufacturer. This will be used as the USB manufacturer string. Can include Unicode characters, escaped to ASCII eg. <code>\\u03A8</code> (Ψ).</li><li>Example: <code>"Clueboard"</code></li></ul></li><li><code>url</code> (Required) <ul><li>A URL to the keyboard's product page, <a href="https://qmk.fm/keyboards" target="_blank" rel="noreferrer">QMK.fm/keyboards</a> page, or other page describing information about the keyboard.</li><li>Example: <code>"https://clueboard.co"</code></li></ul></li><li><code>bootloader_instructions</code><ul><li>Instructions for putting the keyboard into a mode that allows for firmware flashing.</li><li>Example: <code>"Press the button marked RESET on the back of the PCB"</code></li></ul></li><li><code>tags</code><ul><li>A list of tags describing the keyboard.</li><li>Example: <code>["ortho", "split", "rgb"]</code></li></ul></li></ul><h2 id="hardware-configuration" tabindex="-1">Hardware Configuration <a class="header-anchor" href="#hardware-configuration" aria-label="Permalink to "Hardware Configuration {#hardware-configuration}""></a></h2><ul><li><code>board</code><ul><li>Override the default ChibiOS board name (ARM-based keyboards only).</li><li>Example: <code>"BLACKPILL_STM32_F411"</code></li></ul></li><li><code>bootloader</code><ul><li>The bootloader in use on the keyboard. Required if <code>development_board</code> is not specified.</li></ul></li><li><code>development_board</code><ul><li>The microcontroller development board, if appl
|
|||
|
|
const _hoisted_88 = [
|
|||
|
|
_hoisted_1
|
|||
|
|
];
|
|||
|
|
function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
|
|||
|
|
return openBlock(), createElementBlock("div", null, _hoisted_88);
|
|||
|
|
}
|
|||
|
|
const reference_info_json = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
|
|||
|
|
export {
|
|||
|
|
__pageData,
|
|||
|
|
reference_info_json as default
|
|||
|
|
};
|