Skip to main content

Style Guide - Markdown Features

Overview​

We have developed several React components for assisting with writing documentation.

Features​

Light/Dark Mode Switch​

Usage:​

import { Dark, Light } from '/src/components/ColorMode';
<Dark>
  <p>Dark</p>
</Dark>
<Light>
  <p>Light</p>
</Light>

Demo:​

This is only shown in dark mode.

This is only shown in light mode.

Code Blocks​

Usage:​

Always specify the language used directly after the start of the code block (```).

note

For command line examples, please use shell and not any of the other aliases.

for further information please see the relevant Docusaurus page

```ts title="Demo"
export const typedArrayToBuffer = (array: Uint8Array): ArrayBuffer => {
  return array.buffer.slice(
    array.byteOffset,
    array.byteLength + array.byteOffset
  );
};
```

Demo:​

Demo
export const typedArrayToBuffer = (array: Uint8Array): ArrayBuffer => {
  return array.buffer.slice(
    array.byteOffset,
    array.byteLength + array.byteOffset,
  );
};