Mkdocs Template

This template is useful for building the documentations for your McGill-NLP project. It uses Material for MkDocs. You can start by editing the content in docs/. If you need to edit the configurations and/or deploy mkdocs, start with the official Getting Started.

Alternatives

If you are planning to have a main website for your project as well as documentation, it's recommended to use the project-page-template for both, as you would only need to maintain a single repository and use a single framework (i.e. minimal-mistake/Jekyll).

Instructions

• Edit Title: go to mkdocs.yml and change the site_name field.
• Edit GitHub URL in the Footer: go to mkdocs.yml and change the extra > social field.
• Deploy: Go to Settings > Pages > "Source: Github Actions". Now, every time you push to the main branch, the docs will be deployed via a workflow.