https://github.com/majkinetor/mm-docs

Documentation system in a docker container using mkdocs, plantuml and many more
https://github.com/majkinetor/mm-docs

docker documentation-generator markdown mkdocs mkdocs-material mm-docs plantuml python uml

Last synced: 2 months ago
JSON representation

Documentation system in a docker container using mkdocs, plantuml and many more

• Host: GitHub
• URL: https://github.com/majkinetor/mm-docs
• Owner: majkinetor
• License: gpl-3.0
• Created: 2019-02-07T09:53:24.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-06-24T08:40:54.000Z (7 months ago)
• Last Synced: 2024-06-24T09:57:24.478Z (7 months ago)
• Topics: docker, documentation-generator, markdown, mkdocs, mkdocs-material, mm-docs, plantuml, python, uml
• Language: PowerShell
• Homepage:
• Size: 107 KB
• Stars: 17
• Watchers: 5
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MM-DOCS

[![](https://img.shields.io/docker/v/majkinetor/mm-docs/1.2?label=mm-docs)](https://hub.docker.com/r/majkinetor/mm-docs)  ![](https://img.shields.io/docker/pulls/majkinetor/mm-docs)      [TEMPLATE](https://github.com/majkinetor/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](https://github.com/majkinetor/mm-docs-template.git)**.

## About docker image

The image is built upon Alpine linux and:

- [mkdocs](https://www.mkdocs.org/)


Documentation system based on python and markdown

- [mkdocs-material](https://squidfunk.github.io/mkdocs-material/)


Beautiful mkdos theme with number of extensions

- [plantuml](http://plantuml.com)


Markup to make UML diagrams from text files

- [Chromium with Puppeter](https://developers.google.com/web/tools/puppeteer/)


Automation system for generating PDF export and can be used in general

- [Broken Link Checker](https://github.com/stevenvachon/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](https://github.com/nightroman/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.