{"id":21032476,"url":"https://github.com/majkinetor/mm-docs-template","last_synced_at":"2025-07-11T08:12:48.521Z","repository":{"id":76786582,"uuid":"180661579","full_name":"majkinetor/mm-docs-template","owner":"majkinetor","description":"Template to use with mm-docs","archived":false,"fork":false,"pushed_at":"2025-06-03T11:44:43.000Z","size":2678,"stargazers_count":9,"open_issues_count":0,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-07-06T16:58:20.544Z","etag":null,"topics":["documentation","documentation-generator","markdown","mkdocs","mm-docs","plantuml"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"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":null,"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-04-10T20:48:01.000Z","updated_at":"2025-06-03T11:43:39.000Z","dependencies_parsed_at":null,"dependency_job_id":"5d7a97f7-a1c2-4867-a5f2-424bb0f343b4","html_url":"https://github.com/majkinetor/mm-docs-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/majkinetor/mm-docs-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majkinetor%2Fmm-docs-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majkinetor%2Fmm-docs-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majkinetor%2Fmm-docs-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majkinetor%2Fmm-docs-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/majkinetor","download_url":"https://codeload.github.com/majkinetor/mm-docs-template/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/majkinetor%2Fmm-docs-template/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264763749,"owners_count":23660319,"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","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":["documentation","documentation-generator","markdown","mkdocs","mm-docs","plantuml"],"created_at":"2024-11-19T12:43:21.112Z","updated_at":"2025-07-11T08:12:48.478Z","avatar_url":"https://github.com/majkinetor.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MM-DOCS Template\n\n[![Build status](https://github.com/majkinetor/mm-docs-template/actions/workflows/mm-docs.yml/badge.svg)](https://github.com/majkinetor/mm-docs-template/actions/workflows/mm-docs.yml)\n[![](http://transparent-favicon.info/favicon.ico)](#)\n[![](http://transparent-favicon.info/favicon.ico)](#)\n[VIEW DEMO](https://majkinetor.github.io/mm-docs-template)\n\nThis project is used to produce all forms of documentation for the service using Markdown and other repository friendly markup languages.\n\nThe documentation is created using the [mm-docs](https://github.com/majkinetor/mm-docs) documentation bundle.\n\nView how compiled static site looks like on [demo site](https://majkinetor.github.io/mm-docs-template) or grab generated [artifact](https://ci.appveyor.com/project/majkinetor/mm-docs-template/build/artifacts). Check out [pdf export](https://majkinetor.github.io/mm-docs-template/docs.pdf) of [single demo page](https://majkinetor.github.io/mm-docs-template/demo).\n\nSee entire docs as a [single page](https://majkinetor.github.io/mm-docs-template/docs.html) and/or [download](https://majkinetor.github.io/mm-docs-template/download.html) it.\n\n## Features\n\n- Documentation in Markdown, HTML, PlantUML, MatJax\n- Beautiful responsive design using the [material](https://squidfunk.github.io/mkdocs-material) theme\n- Navigational bar, TOC, color themes, go-to-top, search and various rich presentation functionalities\n- Custom includables that can be imported in any page: footer, header, abbreviations etc.\n- Variables, Python macros and jinja templates\n- Multilanguage support\n- Keep documentation for multiple user groups in the same project and build only specific one\n- Fast PDF export and single page documentation site\n- Bad link checker for internal and external links\n- Metainformation for every page - last git modification date, source file, authors, etc.\n- GitLab/GitHub repository connection for editing within a browser\n- Automated AppVeyor and Github actions build and deploy to GitHub pages using Ubuntu image\n- Live reload during editing\n- Cross platform for hosting and development with convenient optional PowerShell task system\n\n## Prerequisites\n\n- Docker installation.\n  - For Windows Desktop use: `cinst docker-desktop`\n- PowerShell (optional)\n  - [Invoke-Build](https://www.powershellgallery.com/packages/InvokeBuild) module\n\n## Usage\n\nWithin PowerShell use `Invoke-Build` (ib):\n\n|     Task     |                Description                 |\n| ------------ | ------------------------------------------ |\n| `Build`      | Build static site                          |\n| `Run`        | Serve static site locally with live reload |\n| `Stop`       | Stop  running container                    |\n| `CheckLinks` | Check internal and external links          |\n| `ExportPdf`  | Export PDF of entire site                  |\n| `ExportHTML` | Export standalone HTML of the entire site  |\n| `ExportSite` | Export entire site archive for offline use |\n| `Clean`      | Remove generated data                      |\n\nOtherwise, run appropriate docker commands:\n\n```sh\nexport image=majkinetor/mm-docs\nexport aPort=8888\n\n#build\ndocker run --rm -v $PWD:/docs8 $image mkdocs build\n\n#serve\ndocker run --rm -v $PWD:/docs --name docs-$aPort --detach -p $aPort:$aPort $image mkdocs serve --dev-addr 0.0.0.0:$aPort\n```\n\nAfter building it, static site is available at `source\\site` directory and it can be served with any kind of web server.\n\n## Adding documents\n\n- Add new markdown somewhere in the `source/docs` directory.\n- To be visible in navigation, add to `source/mkdocs.yml` `nav` section, otherwise, the page is available via direct link\n- Add footer, header, abbreviations etc. in `source/inc` folder\n- Add python function and modules in `source/main.py`\n- Override specific mkdocs material theme partials in `source/overrides`\n- Configure PDF and single page stuff in `source/pdf`\n- Configure extra CSS in `docs/_extra/css`\n\n## Notes\n\n- To build only specific section (using `ib -aSection \u003csectionName\u003e`), make sure you have `regex: []` under `exclude` plugin. Because mkdocs builds all pages no matter if they are present in the `nav` section or not, this plugin option is used to NOT build other sections.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmajkinetor%2Fmm-docs-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmajkinetor%2Fmm-docs-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmajkinetor%2Fmm-docs-template/lists"}