Skip to content

Simple readme

mkdocs.yml

# This is the simplest documentation site you could have.  
# It's just a simple readme.
site_name: ok-mkdocs-readme
plugins:
  - simple

Input

ok-mkdocs-readme/
├── mkdocs.yml
└── README.md

Output

site/
├── assets/
│   ├── images/
│   │   └── favicon.png
│   ├── javascripts/
│   │   ├── lunr/
│   │   │   └── min/
│   │   └── workers/
│   └── stylesheets/
└── index.html