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#
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
@startuml
allowmixing
skinparam dpi 600
object User
object Person
object Company
object Representatives
object Customer
object Contractor
object Contract
object Order
object Document
object FileTemplate
object File
file PDF
Customer --|> Person
Customer --|> Company
Contractor --|> Company
Company -left- Person
(Company, Person) .. Representatives
Contractor -up- Contract
Customer -up- Contract
Contractor "1" -right- "*" User
Customer "1" -left- "*" User
Contract "1" -right- "*" Order
Contract -up-|> Document
Order -up-|> Document
Document "1" -right- "*" File
File "*" -- "1" FileTemplate
File -right- PDF
@enduml