{"id":21032478,"url":"https://github.com/majkinetor/mm-docs","last_synced_at":"2025-10-06T17:06:10.815Z","repository":{"id":76786595,"uuid":"169550064","full_name":"majkinetor/mm-docs","owner":"majkinetor","description":"Documentation system in a docker container using mkdocs, plantuml and many more","archived":false,"fork":false,"pushed_at":"2025-04-15T12:59:52.000Z","size":87,"stargazers_count":23,"open_issues_count":5,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-09-23T09:00:46.850Z","etag":null,"topics":["docker","documentation-generator","markdown","mkdocs","mkdocs-material","mm-docs","plantuml","python","uml"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/majkinetor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-02-07T09:53:24.000Z","updated_at":"2025-08-01T07:07:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"b9460945-5759-48e8-b19f-ca32f32143f4","html_url":"https://github.com/majkinetor/mm-docs","commit_stats":null,"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"purl":"pkg:github/majkinetor/mm-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majkinetor%2Fmm-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majkinetor%2Fmm-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majkinetor%2Fmm-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majkinetor%2Fmm-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/majkinetor","download_url":"https://codeload.github.com/majkinetor/mm-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majkinetor%2Fmm-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278646783,"owners_count":26021512,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","documentation-generator","markdown","mkdocs","mkdocs-material","mm-docs","plantuml","python","uml"],"created_at":"2024-11-19T12:43:22.142Z","updated_at":"2025-10-06T17:06:10.799Z","avatar_url":"https://github.com/majkinetor.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MM-DOCS\n\n[![](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) \u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp; [TEMPLATE](https://github.com/majkinetor/mm-docs-template)\n\nThis 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.\n\n**To start writing, clone/use [mm-docs-template](https://github.com/majkinetor/mm-docs-template.git)**.\n\n## About docker image\n\nThe image is built upon Alpine linux and:\n\n- [mkdocs](https://www.mkdocs.org/)\u003cbr\u003e\nDocumentation system based on python and markdown\n- [mkdocs-material](https://squidfunk.github.io/mkdocs-material/)\u003cbr\u003e\nBeautiful mkdos theme with number of extensions\n- [plantuml](http://plantuml.com)\u003cbr\u003e\nMarkup to make UML diagrams from text files\n- [Chromium with Puppeter](https://developers.google.com/web/tools/puppeteer/)\u003cbr\u003e\nAutomation system for generating PDF export and can be used in general\n- [Broken Link Checker](https://github.com/stevenvachon/broken-link-checker)\u003cbr\u003e\nCommand line tool to check for broken links\n- Number of mkdocs and markdown extensions and plugins\n\n## Prerequisites\n\n- Docker to build, serve and develop\n  - On Windows: `choco install wsl2 docker-desktop`\n- PowerShell for the convenient task system (optional)\n    - [Invoke-Build](https://github.com/nightroman/Invoke-Build): `Install-Module InvokeBuild`\n\n## Usage\n\nRun `Invoke-Build ?` to get the list of available tasks. Most important ones are given bellow.\n\n|   Command    |                            Description                             |\n| ------------ | ------------------------------------------------------------------ |\n| `ib Build`   | Build docker image                                                 |\n| `ib Update`  | Build docker image with all components updated                     |\n| `ib Publish` | Publish latest image as new tag, make sure to run Update before it |\n\nwhere `ib` is alias to Invoke-Build.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmajkinetor%2Fmm-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmajkinetor%2Fmm-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmajkinetor%2Fmm-docs/lists"}