forked from kofal.net/zmk
feat(docs): Added a Spelling Error Caution Notice
This commit is contained in:
@@ -5,6 +5,7 @@ hide_title: true
|
|||||||
slug: ./
|
slug: ./
|
||||||
---
|
---
|
||||||
|
|
||||||
|
import SpellingCaution from "@site/src/components/codes/SpellingCaution";
|
||||||
import OsLegend from "@site/src/components/codes/OsLegend";
|
import OsLegend from "@site/src/components/codes/OsLegend";
|
||||||
import ToastyContainer from "@site/src/components/codes/ToastyContainer";
|
import ToastyContainer from "@site/src/components/codes/ToastyContainer";
|
||||||
import Key, { toc as keyToc } from "./_keyboard-keypad.mdx";
|
import Key, { toc as keyToc } from "./_keyboard-keypad.mdx";
|
||||||
@@ -23,6 +24,7 @@ export const toc = [
|
|||||||
...powerToc,
|
...powerToc,
|
||||||
];
|
];
|
||||||
|
|
||||||
|
<SpellingCaution />
|
||||||
<OsLegend />
|
<OsLegend />
|
||||||
<ToastyContainer />
|
<ToastyContainer />
|
||||||
<Key />
|
<Key />
|
||||||
|
|||||||
22
docs/src/components/codes/SpellingCaution.jsx
Normal file
22
docs/src/components/codes/SpellingCaution.jsx
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (c) 2020 The ZMK Contributors
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: CC-BY-NC-SA-4.0
|
||||||
|
*/
|
||||||
|
|
||||||
|
import React from "react";
|
||||||
|
import Admonition from "@theme/Admonition";
|
||||||
|
|
||||||
|
export default function SpellingCaution() {
|
||||||
|
return (
|
||||||
|
<Admonition type="caution">
|
||||||
|
<p>
|
||||||
|
Take extra notice of the spelling of the keycodes, especially the
|
||||||
|
shorthand spelling. Otherwise, it will result in an elusive parsing
|
||||||
|
error!
|
||||||
|
</p>
|
||||||
|
</Admonition>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
SpellingCaution.propTypes = {};
|
||||||
Reference in New Issue
Block a user