rasti.hil@hilandco.com +41 79 367-9677

Using MkDocs with git on Windows and Linux



MkDocs is  static site generator.

Windows  

choco install python
choco install pip

set https_proxy=http://localhost:3128

pip install --upgrade pip --user

pip install mkdocs
setx PATH "%PATH%;C:\Users\%USERNAME%\AppData\Roaming\Python\Python39\Scripts"


cd git _folder
mkdir docs
notepad  mkdocs.yml
site_name: My Docs
nav:
    - Home: readme.md
theme: readthedocs


mkdocs build --clean


git  commit -a -m "mkdocs updates"

git push

Linux

sudo su
export HTTPS_PROXY=http://localhost:3128
pip3 install mkdocs

pip3 install docker-compose

cd git _folder

mkdir docs

echo -e "
site_name: My Docs
nav:
    - Home: readme.md
theme: readthedocs" >mkdocs.yml

echo -e "# test" > docs/readme.md

mkdocs build --clean

git  commit -a -m "mkdocs updates"

git push