Welcome to MkDocs¶
For full documentation visit mkdocs.org.
Install¶
sudo apt install python
sudo apt install python-pip -y
pip install --upgrade pip
wget https://bootstrap.pypa.io/get-pip.py
python get-pip.py
pip install mkdocs
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.