mkdocs
Project documentation with Markdown. More information: <https://www.mkdocs.org>.
Install
- All systems
-
curl cmd.cat/mkdocs.sh
- Debian
-
apt-get install mkdocs - Ubuntu
-
apt-get install mkdocs - Kali Linux
-
apt-get install mkdocs - Fedora
-
dnf install mkdocs - Windows (WSL2)
-
sudo apt-get updatesudo apt-get install mkdocs - OS X
-
brew install mkdocs - Raspbian
-
apt-get install mkdocs - Dockerfile
- dockerfile.run/mkdocs
Project documentation with Markdown. More information: <https://www.mkdocs.org>.
-
Create a new mkdocs project:
mkdocs new project_name -
Serve the project in the current directory using the mkdocs dev-server:
mkdocs serve -
Build the documentation in the current directory:
mkdocs build -
Deploy the documentation in the current directory to GitHub pages:
mkdocs gh-deploy
© tl;dr; authors and contributors