gpaluru / technotes

technotes

Builds every time you push a change to the master branch.

Uses the Github Action Deploy MkDocs to build the page and put the build artifacts to gh-pages branch. Afterwards github pages is used to host the page under: http://crowdsalat.github.io/technotes.

Install

sudo pip3 install mkdocs

sudo pip3 install mkdocs-material

sudo might be necessary to add mkdocs on the path. If you want to change color or the navigation refer to mkdocs martial setup guide.

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.
• mkdocs gh-deploy --clean - Builds the site and push the generated artefacts to gh-pages branch of the repo

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.