https://github.com/crowdsalat/technotes

https://github.com/crowdsalat/technotes

gh-pages mkdocs

Last synced: 22 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/crowdsalat/technotes
• Owner: CrowdSalat
• Created: 2019-10-19T18:15:00.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-04-10T13:59:14.000Z (23 days ago)
• Last Synced: 2025-04-10T14:59:15.619Z (23 days ago)
• Topics: gh-pages, mkdocs
• Homepage: http://crowdsalat.github.io/technotes
• Size: 2.75 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Security: docs/security_scanner.md

Awesome Lists containing this project

README

        
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/CrowdSalat/technotes)

# technotes

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

Uses the Github Action [Deploy MkDocs](https://github.com/marketplace/actions/deploy-mkdocs) to build the page and put the build artifacts to [gh-pages](https://github.com/CrowdSalat/technotes/tree/gh-pages) branch. Afterwards [github pages](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages) is used to host the page under: [**http://crowdsalat.github.io/technotes**](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](https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/).

## 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.