{"id":13316990,"url":"https://github.com/homecentr/docker-mkdocs-material","last_synced_at":"2025-03-11T00:33:22.645Z","repository":{"id":37214327,"uuid":"257882154","full_name":"homecentr/docker-mkdocs-material","owner":"homecentr","description":null,"archived":true,"fork":false,"pushed_at":"2023-01-20T00:00:56.000Z","size":104,"stargazers_count":1,"open_issues_count":9,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-07-29T19:15:01.480Z","etag":null,"topics":["docker-image","drawio","homecentr","mkdocs","mkdocs-material"],"latest_commit_sha":null,"homepage":"https://homecentr.github.io","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/homecentr.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":"SECURITY.md","support":null}},"created_at":"2020-04-22T11:33:33.000Z","updated_at":"2024-07-29T19:15:01.481Z","dependencies_parsed_at":"2023-02-11T22:45:14.741Z","dependency_job_id":null,"html_url":"https://github.com/homecentr/docker-mkdocs-material","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":"homecentr/docker-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/homecentr%2Fdocker-mkdocs-material","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/homecentr%2Fdocker-mkdocs-material/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/homecentr%2Fdocker-mkdocs-material/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/homecentr%2Fdocker-mkdocs-material/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/homecentr","download_url":"https://codeload.github.com/homecentr/docker-mkdocs-material/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221201755,"owners_count":16775402,"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":["docker-image","drawio","homecentr","mkdocs","mkdocs-material"],"created_at":"2024-07-29T18:23:43.873Z","updated_at":"2024-10-23T13:30:28.861Z","avatar_url":"https://github.com/homecentr.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Project status](https://badgen.net/badge/project%20status/stable%20%26%20actively%20maintaned?color=green)](https://github.com/homecentr/docker-mkdocs-material/graphs/commit-activity) [![](https://badgen.net/github/label-issues/homecentr/docker-mkdocs-material/bug?label=open%20bugs\u0026color=green)](https://github.com/homecentr/docker-mkdocs-material/labels/bug) [![](https://badgen.net/github/release/homecentr/docker-mkdocs-material)](https://hub.docker.com/repository/docker/homecentr/mkdocs-material)\n[![](https://badgen.net/docker/pulls/homecentr/mkdocs-material)](https://hub.docker.com/repository/docker/homecentr/mkdocs-material) \n[![](https://badgen.net/docker/size/homecentr/mkdocs-material)](https://hub.docker.com/repository/docker/homecentr/mkdocs-material)\n\n![CI/CD on master](https://github.com/homecentr/docker-mkdocs-material/workflows/CI/CD%20on%20master/badge.svg)\n![Regular Docker image vulnerability scan](https://github.com/homecentr/docker-mkdocs-material/workflows/Regular%20Docker%20image%20vulnerability%20scan/badge.svg)\n\n\n# HomeCentr - mkdocs material\nThis docker image is an enriched version of the original [squidfunk's mkdocs-material](https://github.com/squidfunk/mkdocs-material) and adds [drawio-exporter](https://github.com/LukeCarrier/mkdocs-drawio-exporter) on top of that. The set up of the [drawio-exporter](https://github.com/LukeCarrier/mkdocs-drawio-exporter) and it's dependencies is not completely straightforward so I thought it could be also useful to others :wink:\n\n## Usage\n\nUpdate your mkdocs.yml file according to the guide in [drawio-exporter](https://github.com/LukeCarrier/mkdocs-drawio-exporter). Note that the container is running as root by default which means you have to add the `--no-sandbox` argument as shown below.\n\n```yml\nplugins:\n  - drawio-exporter:\n      drawio_args:\n        - --no-sandbox\n```\n\n### Powershell\n\n```Powershell\ndocker run --rm -it -p 8000:8000 -v ${$PWD}:/docs homecentr/mkdocs\n```\n\n### Bash\n\n```Bash\ndocker run --rm -it -p 8000:8000 -v ${PWD}:/docs homecentr/mkdocs\n```\n\n## Exposed ports\n\n| Port | Protocol | Description |\n|------|------|-------------|\n| 8000 | TCP | MkDocs development server |\n\n## Volumes\n\n| Container path| Description |\n|------|-------------|\n| /docs | Default working directory, this should be the directory with the mkdocs.yml file |\n\n## Security \nThe container is regularly scanned for vulnerabilities and updated. Further info can be found in the [Security tab](https://github.com/homecentr/docker-mkdocs/security).\n\n### Container user\nThe container is tested to be running as a root. Given that it is a development container which should not be deployed anywhere and only used at build time this is an accepted feature.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhomecentr%2Fdocker-mkdocs-material","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhomecentr%2Fdocker-mkdocs-material","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhomecentr%2Fdocker-mkdocs-material/lists"}