An expeiemental project to convert the Ultra Essentials into a static site using MkDocs. The main goals of this project are:
- To make the project more accessible to the DigEd team as well as the wider community of learning technologists and educators.
- To take advantages of Git and Github such as branches, version control, issue tracking, and pull requests to enhance the current workflow.
- To use static site generator such as MkDocs to publish the changes automatically.
- MkDocs - A fast, simple and downright gorgeous static site generator that's geared towards building project documentation.
- Material for MkDocs - A Material Design theme for MkDocs.
- Markdown - A lightweight markup language with plain-text-formatting syntax.
- Python
- Git
- Github Actions - A CI/CD tool that helps you automate your workflow.
- ✅ Easy to use
- ✅ Easy to update
- ✅ Version control
- ✅ Track changes
- ✅ Multiple contributors
- ✅ Responsive design
- ✅ Multilingual support
- ✅ Search functionality
- ✅ Dark mode
- ✅ PDF export
- ✅ Customisable
- ✅ Markdown support
A list of installed plugins allows us to extend the functionality of this project.
- mkdocs-video - Embed videos directly using standard Markdown syntax.
- mkdocs-autolinks-plugin - Automatically link to other pages in your MkDocs documentation.
- mkdocs-roamlinks-plugin - A folk of mkdocs-autolinks-plugin that allows you to link to other pages in your MkDocs documentation.
- git-revision-date-localized-plugin - A plugin for MkDocs that displays the last modification date of a file in the local timezone.
- mkdocs-static-i18n - Adds static internationalisation support to MkDocs for multilingual sites.