Skip to main content

MDX Reference

Capitalisation​

Capitalisation of the top level Heading and Filename of an .mdx file is mandatory, or the commit will fail. The required capitalisation will be indicated in the commit failure message.

Capitalisation should be otherwise be consistent throughout the document, and ideally across the whole site.

Capitalisation should be applied to proper names or defined or technical terms, but not otherwise. For example, "Tasks", when capitalised, may be appropriate when referring to the Configurator "Tasks" tab, or a "Tasks" function, whereas "tasks", uncapitalised, would be more appropriate in the sense that "when controlling a drone, the pilot undertakes many tasks".

Some technical terms have standard capitalisation, eg SmartAudio, DShot, HDZero, ExpressLRS, and we should be consistent with these.

Header 1

Header 2​

Header 3​

Header 4​

Header 5​
Header 6​

Normal text.

Normal text after empty line. Normal text on next line.

italic text

bold text

bold italic text

strikethrough text

blockquote


  • list item 1
  • list item 2
    • list item 2a
    • list item 2b
  • list item 3

some text

  1. numbered list item 1
  2. numbered list item 2
    1. numbered list item 2a
    2. numbered list item 2a
  3. numbered list item 3
    A coded break is to separate text from ordered lists

Inline code: const foo = 'bar';

Code block:

const foo: string = 'bar'
# MDX Reference

# Header 1

## Header 2

### Header 3

#### Header 4

##### Header 5

###### Header 6

Normal text.

Normal text after empty line.
Normal text on next line.

_italic text_

**bold text**

**_bold italic text_**

~~strikethrough text~~

> blockquote

<br/>

- list item 1
- list item 2
    - list item 2a
    - list item 2b
- list item 3

some text

1. numbered list item 1
1. numbered list item 2
    1. numbered list item 2a
    1. numbered list item 2a
1. numbered list item 3
<br/>
A coded break is to separate text from ordered lists

`const foo = 'bar';`

\```
const foo: string = 'bar';
\```

\{/_ wow so meta _/}

Tabs​

This is tab 1

<Tabs>
  <TabItem value="tab1" label="Tab 1" default> This is tab 1 </TabItem>
  <TabItem value="tab2" label="Tab 2"> This is tab 2 </TabItem>
  <TabItem value="tab3" label="Tab 3"> This is tab 3 </TabItem>
</Tabs>
<!-- even more meta -->

Admonitions​

note

This is a note. It notes things.

caution

This is a caution. It cautions things.

danger

This is a danger. It is dangerous.

info

This is an info. It informs things.

tip

This is a tip. It tips things.

Mermaid Flow Charts​

LaTeX\LaTeX Equations​

Let f ⁣:[a,b]→Rf\colon[a,b]\to\R be Riemann integrable. Let F ⁣:[a,b]→RF\colon[a,b]\to\R be F(x)=∫axf(t) dtF(x)=\int_{a}^{x} f(t)\,dt. Then FF is continuous, and at all xx such that ff is continuous at xx, FF is differentiable at xx with F′(x)=f(x)F'(x)=f(x).

This is a block of aligned LaTeX\LaTeX equations:

∇⋅E⃗=ρϵ0∇⋅B⃗=0∇×E⃗=−∂B⃗∂t∇×B⃗=μ0(J⃗+ϵ0∂E⃗∂t)\begin{align} \nabla \cdot \vec{\bf{E}} &= \frac{\rho}{\epsilon_0} \\ \nabla \cdot \vec{\bf{B}} &= 0 \\ \nabla \times \vec{\bf{E}} &= - \frac{\partial \vec{\bf{B}}}{\partial \mathrm{t}} \\ \nabla \times \vec{\bf{B}} &= \mu_0 \left( \vec{\bf{J}} + \epsilon_0 \frac{\partial \vec{\bf{E}}}{\partial \mathrm{t}} \right) \end{align}

Images​

Betaflight Configurator Fig. 1 - centered image.

<p align="center">
  ![Betaflight Configurator](/img/MagOrientationDiagram.png)
  **Fig. 1** - centered image.
</p>