{"id":18606059,"url":"https://github.com/hfagerlund/docker-for-docskimmer","last_synced_at":"2025-11-02T11:30:31.207Z","repository":{"id":205394839,"uuid":"714124691","full_name":"hfagerlund/docker-for-docskimmer","owner":"hfagerlund","description":"Check the compatibility of docSkimmer theme and MkDocs versions using Docker","archived":false,"fork":false,"pushed_at":"2023-11-07T01:35:30.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-27T00:11:45.595Z","etag":null,"topics":["dockerfile","docskimmer-theme","mkdocs","mkdocs-docskimmer"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hfagerlund.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-11-04T01:35:03.000Z","updated_at":"2023-11-04T02:05:11.000Z","dependencies_parsed_at":"2023-11-07T04:04:51.379Z","dependency_job_id":"f2f47274-afd6-4f8d-909b-2d929ef9bb88","html_url":"https://github.com/hfagerlund/docker-for-docskimmer","commit_stats":null,"previous_names":["hfagerlund/docker-for-docskimmer"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hfagerlund%2Fdocker-for-docskimmer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hfagerlund%2Fdocker-for-docskimmer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hfagerlund%2Fdocker-for-docskimmer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hfagerlund%2Fdocker-for-docskimmer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hfagerlund","download_url":"https://codeload.github.com/hfagerlund/docker-for-docskimmer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239394716,"owners_count":19631122,"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":["dockerfile","docskimmer-theme","mkdocs","mkdocs-docskimmer"],"created_at":"2024-11-07T02:24:07.494Z","updated_at":"2025-11-02T11:30:31.173Z","avatar_url":"https://github.com/hfagerlund.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# docker-for-docskimmer\n\nThis project uses a Dockerfile to automate git cloning the repo for easily testing the compatibility of **various [docSkimmer theme](https://github.com/hfagerlund/mkdocs-docskimmer) and [MkDocs](https://github.com/mkdocs/mkdocs) versions** (either current, or [otherwise specified](https://github.com/hfagerlund/docker-for-docskimmer#specify-versions)) *without having to install either locally*.\n\n## Quickstart\n```console\n$ sudo systemctl start docker\n$ sudo docker build . -t my-docskimmer -f Dockerfile\n$ sudo docker run -p 8000:8080 my-docskimmer\n```\n* Browse to http://0.0.0.0:8000/mkdocs-docskimmer/ :tada:\n\n## Example output\nAn excerpt of **successful build output** is shown below:\n\u003e *(using MkDocs v1.5.3 with docSkimmer theme 'master' branch)*\n\n```console\n$ sudo docker build . -t my-docskimmer -f Dockerfile\n[+] Building 6.9s (11/11) FINISHED\n =\u003e [internal] load .dockerignore                                                                    0.4s\n =\u003e =\u003e transferring context: 2B                                                                      0.0s\n =\u003e [internal] load build definition from Dockerfile                                                 0.3s\n =\u003e =\u003e transferring dockerfile: 467B                                                                 0.0s\n =\u003e [internal] load metadata for docker.io/library/python:3.8.2                                      0.9s\n =\u003e [internal] load build context                                                                    0.2s\n =\u003e =\u003e transferring context: 618B                                                                    0.0s\n =\u003e [1/6] FROM docker.io/library/python:3.8.2@sha256:8c98602bf4f4b2f9b6bd8def396d5149821c59f8a69e74  0.0s\n =\u003e CACHED [2/6] WORKDIR /build                                                                      0.0s\n =\u003e CACHED [3/6] COPY requirements.txt .                                                             0.0s\n =\u003e CACHED [4/6] RUN pip install --no-cache-dir -r requirements.txt                                  0.0s\n =\u003e [5/6] COPY docs_local-updates ./my-project/docs                                                  1.0s\n =\u003e [6/6] COPY mkdocs.yml ./my-project/mkdocs.yml                                                    0.8s\n =\u003e exporting to image                                                                               2.4s\n =\u003e =\u003e exporting layers                                                                              2.2s\n =\u003e =\u003e writing image sha256:0274aee1e791ec0f0af2df18b3df607c41b0640a9fe2e7af0cbed8d8e24a94ac         0.1s\n =\u003e =\u003e naming to docker.io/library/my-docskimmer                                                     0.1s\n\n## NOTE: warnings (below) do not break the build\n\n$ sudo docker run -p 8000:8080 my-docskimmer\nWARNING -  Config value 'dev_addr': The use of the IP address '0.0.0.0' suggests a production environment or the use of a proxy to connect to the MkDocs server. However, the MkDocs' server is intended for local development purposes only. Please use a third party production-ready server instead.\nINFO    -  Building documentation...\nINFO    -  Cleaning site directory\nINFO    -  Documentation built in 0.29 seconds\nINFO    -  [00:38:37] Watching paths for changes: 'my-project/docs', 'my-project/mkdocs.yml'\nINFO    -  [00:38:37] Serving on http://0.0.0.0:8080/\nINFO    -  [00:38:39] Browser connected: http://0.0.0.0:8000/\n## ...\n```\n\n### Summary of steps\n* start Docker: `$ sudo systemctl start docker`;\n* build and tag the Docker image 'my-docskimmer': `$ sudo docker build . -t my-docskimmer -f Dockerfile`;\n  * **NOTE**: run this in the same directory as the [Dockerfile](https://github.com/hfagerlund/docker-for-docskimmer/blob/main/Dockerfile))\n* run Docker image 'my-docskimmer': `$ sudo docker run -p 8000:8080 my-docskimmer`;\n  * this maps port 8080 in the container to port 8000 on the Docker host\n* browse to http://0.0.0.0:8000/mkdocs-docskimmer/\n  * see `view-source:http://0.0.0.0:8000/mkdocs-docskimmer/` for version numbers of both the docSkimmer theme and MkDocs\n\n### Specify Versions\n#### Python\n* **line 3** of the [Dockerfile](https://github.com/hfagerlund/docker-for-docskimmer/blob/main/Dockerfile#L3): Specify the Python version (for compatibility with MkDocs - refer to [user guide](https://www.mkdocs.org/user-guide/installation/);\n\n#### MkDocs\n* **line 1** of [requirements.txt](https://github.com/hfagerlund/docker-for-docskimmer/blob/main/requirements.txt#L1): Specify the [MkDocs version](https://github.com/mkdocs/mkdocs/releases/) - (latest: **v1.5.3** - *at time of writing*);\n\n#### docSkimmer theme\n* **line 2** of [requirements.txt](https://github.com/hfagerlund/docker-for-docskimmer/blob/main/requirements.txt#L2): Specify the tag, release/version, or branch of [docSkimmer theme](https://github.com/hfagerlund/mkdocs-docskimmer/releases) - (note: `master` branch contains the latest, unreleased changes since **v0.4.0**)\n\n  **examples**: \u003cbr\u003e\n  * install latest changes (ie. 'master' branch'):\n  ```\n  pip install git+https://github.com/hfagerlund/mkdocs-docskimmer.git@master\n  ```\n  * install version 0.3.1:\n  ```\n  pip install git+https://github.com/hfagerlund/mkdocs-docskimmer.git@v0.3.1\n  ```\n  * install experimental branch 'issue-17_fix-config-value':\n  ```\n  pip install git+https://github.com/hfagerlund/mkdocs-docskimmer.git@issue-17_fix-config-value\n  ```\n\n\n### Nice to know\n\u003cdetails\u003e\n  \u003csummary\u003eDocker commands\u003cstrong\u003e [+]\u003c/strong\u003e\u003c/summary\u003e\n\n\u003cbr /\u003e\n\n* List Docker images (eg. 'my-docskimmer'):\n```console\n$ sudo docker images\n```\n\n* List Docker containers:\n```console\n$ sudo docker container ls -a\n```\n\n* Remove Docker image 'my-docskimmer' once finished:\n```console\n$ sudo docker rmi -f my-docskimmer\n```\n\n* Debug Docker build (display output of commands not loaded from cache):\n```console\n$ sudo docker build --progress=plain --no-cache . -t my-docskimmer -f Dockerfile\n```\n\n* Stop Docker:\n```console\n$ sudo systemctl stop docker\n```\n\n* Check whether Docker is running:\n```console\n$ sudo systemctl status docker\n```\n\u003c/details\u003e\n\n## License\nCopyright (c) 2023 Heini Fagerlund. Licensed under the [BSD-3-Clause license](https://github.com/hfagerlund/docker-for-docskimmer/blob/main/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhfagerlund%2Fdocker-for-docskimmer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhfagerlund%2Fdocker-for-docskimmer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhfagerlund%2Fdocker-for-docskimmer/lists"}