{"repo":"majkinetor/mm-docs","free":true,"listed":false,"github":"https://github.com/majkinetor/mm-docs","clone":"git clone https://github.com/majkinetor/mm-docs.git","description":"Documentation system in a docker container using mkdocs, plantuml and many more","language":"PowerShell","stars":23,"topics":["mkdocs","markdown","plantuml","uml","docker","mkdocs-material","python","documentation-generator","mm-docs"],"license":"GPL-3.0","category":"docs-static-sites","readme_excerpt":"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 wsl2 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. Command Description ------------ ------------------------------------------------------------------ ib Build Build docker image ib Update Build docker image with all components updated ib Publish Publish latest image as new tag, make sure to run Update before it where ib is alias to Invoke-Build.","default_branch":null,"files":null,"tree":[],"storefront":"/r/majkinetor","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/majkinetor/mm-docs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}