How to create a note¶

For full documentation visit mkdocs.org.

Theme¶

This document's theme is squidfunk/mkdocs-material.

To customize, see also mkdocs-material/customization/.

Project layout¶

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Code highlight¶

1
2
3

function blah(foo) {
  console.log(`foo: ${foo}`);
}

const Blah = props => (
  <div>
    Hello world!
  </div>
);

Math¶

Warning

This function is not markdown standard, so you should follow the usage and dosage instructions.

Using MathJax

$P\cdot Q = \|P\|\|Q\|\cos\alpha$

Emoji¶

See EMOJI CHEAT SHEET

Release

Icons¶

Using Font Awesome's icons

bug

Admonition¶

Warning

This function is not markdown standard, so you should follow the usage and dosage instructions.