majkinetor/mm-docs repository overview

⁠MM-DOCS

     TEMPLATE⁠

This is a docker image that setups and runs documentation system designed for all types of project documentation and can be used in cross-platform manner. This repository is not used directly when writing documentation and its purpose is to improve the mm-docs itself.

To start writing, clone/use mm-docs-template⁠.

⁠About docker image

The image is built upon Alpine linux and:

• mkdocs⁠
  Documentation system based on python and markdown
• mkdocs-material⁠
  Beautiful mkdos theme with number of extensions
• plantuml⁠
  Markup to make UML diagrams from text files
• Chromium with Puppeter⁠
  Automation system for generating PDF export and can be used in general
• Broken Link Checker⁠
  Command line tool to check for broken links
• Number of mkdocs and markdown extensions and plugins

⁠Prerequisites

• Docker to build, serve and develop
  • On Windows: choco install docker-desktop
• PowerShell for the convenient task system (optional)
  • Invoke-Build⁠: Install-Module InvokeBuild

⁠Usage

Run Invoke-Build ? to get the list of available tasks. Most important ones are given bellow.

where ib is alias to Invoke-Build.