Welcome to MkDocs

This is a test site hosted on GitLab Pages. You can browse its source code, fork it and start using it on your projects.

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 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.

mkdocs material examples

tab view in mkdocs

Simply add the following lines to mkdocs.yml to enable the theme. Note that since there are several [installation methods][2], configuration might be slightly different:

theme:
  name: material

theme:
  name: null
  custom_dir: mkdocs-material/material

  # 404 page
  static_templates:
    - 404.html

  # Necessary for search to work properly
  include_search_page: false
  search_index_only: true

  # Default values, taken from mkdocs_theme.yml
  language: en
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/favicon.png
  icon:
    logo: logo

Advanced configuration

Material for MkDocs comes with many configuration options. The setup section explains in great detail how to configure and customize colors, fonts, icons and much more:

Python code

# Python program to display all the prime numbers within an interval

lower = 900
upper = 1000

print("Prime numbers between", lower, "and", upper, "are:")

for num in range(lower, upper + 1):
   # all prime numbers are greater than 1
   if num > 1:
       for i in range(2, num):
           if (num % i) == 0:
               break
       else:
           print(num)

C++ code

#include <iostream>

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

QML code

Rectangle {
    color: "green"
    x: 5; y: 10
    width: 50
    height: 2 * width
}

Mermaid

graph TD
    A[Client] --> B[Load Balancer]
    B --> C[Server01]
    B --> D[Server02]

classDiagram
    Animal <|-- Duck
    Animal <|-- Fish
    Animal <|-- Zebra
    Animal : +int age
    Animal : +String gender
    Animal: +isMammal()
    Animal: +mate()
    class Duck{
        +String beakColor
        +swim()
        +quack()
    }
    class Fish{
        -int sizeInFeet
        -canEat()
    }
    class Zebra{
        +bool is_wild
        +run()
    }

pie
  title Key elements in Product X
  "Calcium" : 42.96
  "Potassium" : 50.05
  "Magnesium" : 10.01
  "Iron" :  5

journey
  title My working day
  section Go to work
    Make tea: 5: Me
    Go upstairs: 3: Me
    Do work: 1: Me, Cat
  section Go home
    Go downstairs: 5: Me
    Sit down: 5: Me

graph LR
    A[Start] --> B{Error?}
    B -->|Yes| C[Hmm...]
    C --> D[Debug]
    D --> B
    B -->|No| E[Yay..]

graph TD
    A[Client] --> B[Load Balancer]
    B --> C[Server01]
    B --> D[Server02]

graph TD
    A[Start] --> B{Is it?}
    B -->|Yes| C[OK]
    C --> D[Rethink]
    D --> B
    B ---->|No| E[End]

Admonitions

Loremlf adsäöflk asädöfkl sdfäöakls fäöalsdk fäadlsöfkLoremlf adsäöflk asädöfkl sdfäöakls fäöalsdk fäadlsöfkLoremlf adsäöflk asädöfkl sdfäöakls fäöalsdk fäadlsöfkLoremlf adsäöflk asädöfkl sdfäöakls fäöalsdk fäadlsöfkLoremlf adsäöflk asädöfkl sdfäöakls fäöalsdk fäadlsöfkLoremlf adsäöflk asädöfkl sdfäöakls fäöalsdk fäadlsöfkLoremlf adsäöflk asädöfkl sdfäöakls fäöalsdk fäadlsöfkLoremlf adsäöflk asädöfkl sdfäöakls fäöalsdk fäadlsöfkLoremlf adsäöflk asädöfkl sdfäöakls fäöalsdk fäadlsöfkLoremlf adsäöflk asädöfkl sdfäöakls fäöalsdk fäadlsöfkLoremlf adsäöflk

ein anderes krassetextein anderes krassetextein anderes krassetextein anderes krassetextein anderes krassetextein anderes krassetextein anderes krassetextein anderes krassetextein anderes krassetextein anderes krassetextein anderes krassetextein anderes krassetextein anderes krassetextein anderes krassetextein anderes krassetextein anderes krassetextein anderes krassetextein anderes krassetextein anderes krassetextein anderes krassetext

Buttons

Download v9.10