Skip to content

Markdown reference

Standard stuff

Test title

Standard markdown stuff

for i in range (1,100):
    print("Syntax highlighting")
    print("George was here")

Notes etc.

Note

This is a note

Bug

This is a bug

Info

These work for:

  • Note
  • Abstract
  • Info
  • Tip
  • Success
  • Question
  • Warning
  • Failure
  • Danger
  • Bug
  • Example
  • Quote

Clicky boi:

What is the answer to life the universe and everything?

42

Maths

f(x) = \left\{ \begin{array}{lr} x^2 & : x < 0\\ x^3 & : x \ge 0 \end{array} \right.

Other stuff

  • Emojis 😄
  • Inline highlighting for print("code")
  • Auto adding of https://www.google.co.uk/search?q=links
  • Highlighting of important stuff
  • Useful arrows and stuff → ±
  • Tasks:
    • Lorem ipsum dolor sit amet, consectetur adipiscing elit
    • Nulla lobortis egestas semper
    • Curabitur elit nibh, euismod et ullamcorper at, iaculis feugiat est
    • Vestibulum convallis sit amet nisi a tincidunt
      • In hac habitasse platea dictumst
      • In scelerisque nibh non dolor mollis congue sed et metus
      • Sed egestas felis quis elit dapibus, ac aliquet turpis mattis
      • Praesent sed risus massa
    • Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque
    • Nulla vel eros venenatis, imperdiet enim id, faucibus nisi

Installation

Clone: git clone ...

Install: pipenv install

Live reload: pipenv run mkdocs serve

Build: pipenv run mkdocs build

Deploy: pipenv run mkdocs gh-deploy