Skip to content

Welcome to MkDocs

For full documentation visit mkdocs.org.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

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

Code Highlighting

1
2
3
#!/bin/bash

echo "Hello world!"

1
2
3
4
5
6
#include <stdio.h>

int main(void) {
  printf("Hello world!\n");
  return 0;
}

1
2
3
4
5
6
#include <iostream>

int main(void) {
  std::cout << "Hello world!" << std::endl;
  return 0;
}

1
2
3
4
5
6
7
using System;

class Program {
  static void Main(string[] args) {
    Console.WriteLine("Hello world!");
  }
}

Math

Use with either $$ … $$ or \[ … ]\ for blocks and \( … \) for inline:

When a \ne 0, there are two solutions to ax^2 + bx + c = 0 and they are

x = {-b \pm \sqrt{b^2-4ac} \over 2a}.
1
2
3
When \(a \ne 0\), there are two solutions to \(ax^2 + bx + c = 0\) and they are

$$x = {-b \pm \sqrt{b^2-4ac} \over 2a}.$$

Notes, Warnings, Hints, etc.

Warning1

Lacinia adipiscing nascetur inceptos id blandit, nascetur sagittis pharetra lacinia metus pede accumsan, quam class urna libero, cubilia. Aenean iaculis lorem quam, maecenas eros commodo gravida augue magna, tempus diam metus nisi, massa fringilla augue nunc, placerat euismod nunc nam arcu,. Tempus auctor erat luctus sodales elit commodo morbi, conubia potenti ultricies gravida amet, hendrerit odio neque. Commodo diam odio dui, accumsan pede eros integer, viverra mauris congue dignissim pellentesque diam, eget magna vel tempus, blandit accumsan condimentum. Cursus ad morbi felis diam.

See more examples here.

To-Do lists

  • 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

Keyboard presses

Ctrl+Alt+My Special Key

Cmd+Alt+Ü

1
2
3
++ctrl+alt+"My Special Key"++

++cmd+alt+"&Uuml;"++

  1. I have no idea what I'm talking about. ↩

Last update: 2020-07-28