Skip to content

Github Pages#

Github Pages is an easy way to create a documentation website (Like this one!).

Creating a GitHub Pages documentation site#

Devex has a UMN GitHub Pages template you can use to setup a Github Pages site quickly with Material for MkDocs; this template currently leverages a Docker container for the MkDocs installation, but for production sites it's recommended to use python for the installation.

To use the template, click the 'Use this template' button in the upper right. Instructions on how to customize the repository are in the README.

[!IMPORTANT] If you use a custom domain for your site, be aware of the possibility of subdomain takeovers! Do not delete the repository where you have the custom domain set, or your domain could be immediately recycled by a malicious entity.

Deleting a GitHub Pages documentation site#

  1. Request that NTS deletes the CNAME alias for your site's custom domain if one exists
  2. Remove the custom domain from Pages settings
  3. Follow GitHub's Deleting a GitHub Pages site instructions