{"id":24564081,"url":"https://github.com/taskbjorn/docker-mkdocs","last_synced_at":"2026-04-11T10:36:16.864Z","repository":{"id":188889926,"uuid":"624610377","full_name":"taskbjorn/docker-mkdocs","owner":"taskbjorn","description":"Docker container for MkDocs - a fast, simple and powerful static site generator geared towards project documentation - based on NGINX. ","archived":false,"fork":false,"pushed_at":"2023-04-07T21:24:52.000Z","size":19,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-23T10:16:56.699Z","etag":null,"topics":["docker","docker-compose","documentation","linux","nginx","static-site-generator"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/taskbjorn/mkdocs","language":"Python","has_issues":false,"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/taskbjorn.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}},"created_at":"2023-04-06T21:22:17.000Z","updated_at":"2023-04-07T21:03:42.000Z","dependencies_parsed_at":"2023-08-17T10:53:57.579Z","dependency_job_id":"bf1d7563-17f9-46e7-a386-688681c3c198","html_url":"https://github.com/taskbjorn/docker-mkdocs","commit_stats":null,"previous_names":["taskbjorn/docker-mkdocs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskbjorn%2Fdocker-mkdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskbjorn%2Fdocker-mkdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskbjorn%2Fdocker-mkdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskbjorn%2Fdocker-mkdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/taskbjorn","download_url":"https://codeload.github.com/taskbjorn/docker-mkdocs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243952039,"owners_count":20373835,"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-compose","documentation","linux","nginx","static-site-generator"],"created_at":"2025-01-23T10:16:58.992Z","updated_at":"2025-10-26T15:15:03.973Z","avatar_url":"https://github.com/taskbjorn.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Quick reference\n\n* Maintained by: [taskbjorn](https://github.com/taskbjorn)\n* Official Git repository: [docker-mkdocs on GitHub](https://github.com/taskbjorn/docker-mkdocs)\n\n# Supported tags and respective Dockerfile links\n\n* [latest](build/latest/Dockerfile)\n\n# What is `docker-mkdocs`?\n\n![Logo](logo.png)\n\n`docker-mkdocs` is a minimalist Docker container based on the official NGINX image to build and serve MkDocs static files.\n\n# Running using Docker Compose\n\nClone this repository to a new folder:\n\n```shell\ngit clone https://github.com/taskbjorn/docker-mkdocs.git\n```\n\nIf the MkDocs source files are stored in a private repository, you must provide the access through a private SSH key. In the following, we will assume the private key is stored in a file `id_rsa.ospk` under the home folder of the active user. \n\n```shell\ncp ~/id_rsa.ospk ./data/.ssh/\nchmod 700 ./data/.ssh\nchmod 600 ./data/.ssh/config ./data/.ssh/id_rsa.ospk\nsudo chown root:root ./data/.ssh\n```\n\n\u003e Note that the `.ssh` folder must be owned by `root` as the container is running under root!\n\nEdit the `docker-compose.yml` file to mount the `.ssh` folder into the container:\n\n```yaml\nservices:\n  app:\n    (...)\n    environment:\n      - \"GIT_REPOSITORY=\u003cyour-repository\u003e\"\n      - \"GIT_EMAIL=\u003cyour-email\u003e\"\n      - \"GIT_USERNAME=\u003cyour-username\u003e\"\n    volumes:\n      - ./.ssh/:/root/.ssh\n      - \u003cyour-path\u003e:/repo\n```\n\nRun the compose stack:\n\n```shell\ndocker-compose up -d\n```\n\n# License\n \nThis image is licensed under [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).\n\nAs it is often the case with Docker images, some of the software contained in this image (e.g. the base image, software included in the base image, etc.) may be covered under a different license.\n\nPlease remember it is your responsibility as the end-user to ensure that your use case complies with the licenses of all included software.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaskbjorn%2Fdocker-mkdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftaskbjorn%2Fdocker-mkdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaskbjorn%2Fdocker-mkdocs/lists"}