Makdocs helper

Some useful info about mkdocs

Documentation links

• For full documentation visit -> mkdocs.org
• Docs about Material template -> github.com

Commands

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

Project layout

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

Examples

Tables

Listener	Target Group	Purpose	Attachment
TCP 80	environment-acme-http	HTTP LE verification requests	The autoscaling group for ECS instances populates this target group on port 80.
TCP 443	environment-acme-https	SSL offload for pm/owners requests	ECS service environment-acme-proxy populates this target group on port 443.

Code

def fn():
    pass

Marked text

This is marked line of text inside regular text

Highlighting specific lines

""" Bubble sort """
def bubble_sort(items):
    for i in range(len(items)):
        for j in range(len(items) - 1 - i):
            if items[j] > items[j + 1]:
                items[j], items[j + 1] = items[j + 1], items[j]

Keyboard shortcuts

Ctrl+Alt+My Special Key

Formula

$$\frac{n!}{k!(n-k)!} = \binom{n}{k}$$

Lorem ipsum dolor sit amet: $p(x|y) = \frac{p(y|x)p(x)}{p(y)}$

Checklist

• 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

Image as code

Nice service to convert images to Base65: https://www.base64-image.de

Comments