mm-docs

KO | EN

gitlite — search

#python #hacktoberfest #react #llm #golang #go #android #windows #awesome #cli #kubernetes #awesome-list #security #mcp

(★ 23)

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

mm-docs 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# MM-DOCS

[![](https://img.shields.io/docker/v/majkinetor/mm-docs/1.3?label=mm-docs)](https://hub.docker.com/r/majkinetor/mm-docs)  ![](https://img.shields.io/docker/pulls/majkinetor/mm-docs) &nbsp;&nbsp;&nbsp;&nbsp; [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.

mm-docs

mm-docs 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

mm-docs

mm-docs 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README