feat(docs): Added a Spelling Error Caution Notice

This commit is contained in:
byran.tech 2022-10-15 15:00:09 -04:00 committed by GitHub
parent ef2e6e9156
commit 3f00f14e36
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 0 deletions

View File

@ -5,6 +5,7 @@ hide_title: true
slug: ./
---
import SpellingCaution from "@site/src/components/codes/SpellingCaution";
import OsLegend from "@site/src/components/codes/OsLegend";
import ToastyContainer from "@site/src/components/codes/ToastyContainer";
import Key, { toc as keyToc } from "./_keyboard-keypad.mdx";
@ -23,6 +24,7 @@ export const toc = [
...powerToc,
];
<SpellingCaution />
<OsLegend />
<ToastyContainer />
<Key />

View 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 = {};