MkDocs on GitHub Pages
MkDocs - GitBook alternative, on GitHub pages
https://squidfunk.github.io/mkdocs-material/
brew install pythonpip3 install mkdocs-materialgit clone git@github.com:<...>/<...>.gitcd $destination_foldermkdocs new .echo "<DOMAIN_NAME>" > CNAMEtee -a mkdocs.yml > /dev/null <<EOTtheme: name: materialEOT
mkdir -p .github/workflowstee -a .github/workflows/ci.yml > /dev/null <<EOTname: cion: push: branches: - master - mainjobs: deploy: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: actions/setup-python@v2 with: python-version: 3.x - run: pip install mkdocs-material - run: mkdocs gh-deploy --forceEOT
mkdocs serve
# edit files as requiredmkdocs build
# git commit & push files# setup gh-pages branch as source of the github pagesMarkdown extensions: https://python-markdown.github.io/extensions/