Skip to content

# Welcome to MkDocs

For full documentation visit mkdocs.org.

## Commands

- `mkdocs new [dir-name]` - Create a new project; or `mkdocs new` in the current folder
- `mkdocs serve` - Start the live-reloading docs server.
- `mkdocs build` - Build the documentation site.
- `mkdocs -h` - Print help message and exit.
- youtube tutorial:

## Links

- Setup
- Reference docs
- Icons search

## Installation

- Create a new virtual environment
- Install mkdocs, type in the console:

          >> pip install mkdocs
          >> pip install mkdocs-material
          >> pip install mkdocs-glightbox

- Start the live-reloading docs server: `mkdocs serve`

## Project layout

    mkdocs.yml    # The configuration file.
    docs
     |----/assets/          # Folder for images etc
     |        logo.png      # Logo image
     |----/css/             # Folder for styles
     |        styles.css    # CSS styles
     |-index.md             # The documentation homepage.
     |-documentation.md     # Another page
       ...                 # Other markdown pages, images and other files.

Text with icons:
or in color as
or
icons search from
https://squidfunk.github.io/mkdocs-material/reference/icons-emojis

# Header 1 - Title `#`

## Header 2 `##`

### Header 3 `###`

h3-like not listed in the table of contents

`div class="h3-like">h3-like not listed in the table of contents</div>`

#### Header 4 `####`

##### Header 5 `#####`

###### Header 6 `#####`