Hello This repo contains the content resources for the management of the Canadian Credential Network (CanaCred) Governance Framework along with the tools necessary to generate two renderings (printed, online) of the CanaCred-GF documents.

1. Online Governance Framework Docs
   • GitHub Pages
   • Canacred Website - Pages Alias
2. CanaCred Framework Docs ([PDF Version] - in development

If you have and use a package manager (such as apt-get, dnf, homebrew, yum, chocolatey, etc.) to install packages on your system, then you may want to search for a "MkDocs" package and, if a recent version is available, install it with your package manager (check your system's documentation for details). That's it, you're done! Skip down to Getting Started.

If your package manager does not have a recent "MkDocs" package, you can still use your package manager to install "Python" and "pip". Then you can use pip to install MkDocs.

Next you will need to install the material theme and pdf plugin

pip install mkdocs-material
pip install mkdocs-pdf-export-plugin

Clone the repo to your drive. Go to the root folder of the repo and run:

mkdocs serve

View the webpages at:

http://127.0.0.1:8000/

This repo uses GitHub Pages to host the static HTML content that is generated by MkDocs. The gh-pages branch reflects the latest committed docs. See make pages.

Use make to manage the build process for this repo.

$ make

1. Clone repository
2. Setup Environment

$ make setup

$ make dev

This repo uses mkdocs gh-deploy to push generated HTML content to GitHub. This process also creates a single PDF document in the pdf folder but the file is not pushed.

$ make pages

Note: You can ignore the DEBUG and WARNING messages during the PDF generation.

To complete the development process, follow normal git commit and git push processing. The .gitignore file will prevent the pushing of the static HTML content.

Please refer to mkdocs-pdf-export-plugin for PDF tooling configuration help.