{"id":24653865,"url":"https://github.com/joshbeard/docker-mkdocs-material","last_synced_at":"2026-04-12T21:38:23.492Z","repository":{"id":86722845,"uuid":"456624302","full_name":"joshbeard/docker-mkdocs-material","owner":"joshbeard","description":"Docker image containing MkDocs + Squidfunk Material theme","archived":false,"fork":false,"pushed_at":"2025-02-12T21:20:59.000Z","size":212,"stargazers_count":0,"open_issues_count":21,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-16T01:48:21.566Z","etag":null,"topics":["docker","docker-image","dockerfile","mkdocs","mkdocs-material"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/joshbeard/mkdocs-material","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"0bsd","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joshbeard.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}},"created_at":"2022-02-07T18:17:24.000Z","updated_at":"2024-07-23T05:34:03.000Z","dependencies_parsed_at":"2024-04-22T04:35:57.647Z","dependency_job_id":"644ea18b-3202-4416-9367-f4ecf7434122","html_url":"https://github.com/joshbeard/docker-mkdocs-material","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshbeard%2Fdocker-mkdocs-material","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshbeard%2Fdocker-mkdocs-material/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshbeard%2Fdocker-mkdocs-material/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshbeard%2Fdocker-mkdocs-material/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joshbeard","download_url":"https://codeload.github.com/joshbeard/docker-mkdocs-material/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244717347,"owners_count":20498283,"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","docker-image","dockerfile","mkdocs","mkdocs-material"],"created_at":"2025-01-25T21:14:20.667Z","updated_at":"2026-04-12T21:38:18.462Z","avatar_url":"https://github.com/joshbeard.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mkdocs-material\n\n[![CodeFactor](https://www.codefactor.io/repository/github/joshbeard/docker-mkdocs-material/badge)](https://www.codefactor.io/repository/github/joshbeard/docker-mkdocs-material)\n\nAn image containing [mkdocs](https://www.mkdocs.org/) with the\n[material](https://squidfunk.github.io/mkdocs-material/) theme and plugins.\n\nThis image is built from the [python](https://hub.docker.com/_/python)\n_3.x-slim_ and _3.x-alpine_ images.\n\n## Project Resources\n\n* Source Repository: \u003chttps://github.com/joshbeard/docker-mkdocs-material\u003e\n* [`Dockerfile`](https://github.com/joshbeard/docker-mkdocs-material/blob/master/Dockerfile): (Alpine; default)\n* [`Dockerfile-slim`](https://github.com/joshbeard/docker-mkdocs-material/blob/master/Dockerfile): (Debian)\n* Docker Hub: \u003chttps://hub.docker.com/r/joshbeard/mkdocs-material\u003e\n\n## Tags\n\n* [`9`](https://github.com/joshbeard/docker-mkdocs-material/blob/master/Dockerfile),\n  [`9-alpine`](https://github.com/joshbeard/docker-mkdocs-material/blob/master/Dockerfile):\n  Current 9.x release from PyPi from the `python:3.x-alpine` Alpine image.\n* [`9-slim`](https://github.com/joshbeard/docker-mkdocs-material/blob/master/Dockerfile-slim):\n  Current 9.x release from PyPi from the `python:3.x-slim` Debian image.\n* [`latest`](https://github.com/joshbeard/docker-mkdocs-material/blob/master/Dockerfile),\n  [`latest-alpine`](https://github.com/joshbeard/docker-mkdocs-material/blob/master/Dockerfile):\n  Current release from PyPi from the `python:3.x-alpine` Alpine image.\n* [`latest-slim`](https://github.com/joshbeard/docker-mkdocs-material/blob/master/Dockerfile-slim):\n  Current release from PyPi from the `python:3.x-slim` Debian image.\n\n## Running\n\nMount a folder with an mkdocs site and `mkdocs.yml` file to `/docs` on the container.\n\n* Start the development server on `:8000`\n\n```shell\ndocker run --rm -it -p 8000:8000 -v ${PWD}:/docs joshbeard/mkdocs-material:9\n```\n\n* Build documentation. This produces static content in a `site/` directory:\n\n```shell\ndocker run --rm -it -v ${PWD}:/docs joshbeard/mkdocs-material:9 build\n```\n\nRefer to the [example](https://github.com/joshbeard/docker-mkdocs-material/tree/master/example) to see an example\nsite using `docker-compose`.\n\n## Plugins\n\n* Check [`builds/latest-requirements.txt`](https://github.com/joshbeard/docker-mkdocs-material/blob/master/builds/latest-requirements.txt)\n* The [example site MkDocs config](https://github.com/joshbeard/docker-mkdocs-material/tree/master/example/mkdocs.yml) has several plugins enabled.\n* \u003chttps://pypi.org/project/pymdown-env/\u003e\n\n## Maintainers\n\n* Josh Beard, \u003chttps://joshbeard.me\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshbeard%2Fdocker-mkdocs-material","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoshbeard%2Fdocker-mkdocs-material","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshbeard%2Fdocker-mkdocs-material/lists"}