Commit b35e0a17 authored by Timm Schoening's avatar Timm Schoening
Browse files

added mkdocs docu

parent 7424f868
Pipeline #73286 failed with stage
in 49 seconds
.wy-nav-content {
max-width: 1500px;
}
# Welcome to MkDocs
For full documentation visit [mkdocs.org](https://www.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
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
site_name: MarIQT Python
strict: true
theme:
name: 'readthedocs'
sticky-navigation: true
plugins:
- search
- macros
- build_plantuml:
output_format: "png"
diagram_root: "docs/images/uml"
output_folder: "out"
input_folder: "src"
input_extensions: "puml"
markdown_extensions:
- smarty
- toc:
baselevel: 1
permalink: "#"
- admonition
- def_list
extra_css: [extra.css]
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment