{"id":13590500,"url":"https://github.com/skyzyx/alpine-pandoc","last_synced_at":"2025-03-25T04:31:42.661Z","repository":{"id":66710362,"uuid":"106754665","full_name":"skyzyx/alpine-pandoc","owner":"skyzyx","description":"Docker container with Alpine Linux, Pandoc, PlantUML, and Sphinx.","archived":false,"fork":false,"pushed_at":"2019-10-02T08:41:33.000Z","size":17,"stargazers_count":20,"open_issues_count":0,"forks_count":8,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-06-09T16:42:23.198Z","etag":null,"topics":["alpine-linux","container","docker","documentation","haskell","java","pandoc","plantuml","python","sphinx"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/skyzyx/alpine-pandoc/","language":"Dockerfile","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/skyzyx.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}},"created_at":"2017-10-12T23:14:34.000Z","updated_at":"2023-06-13T18:41:38.000Z","dependencies_parsed_at":null,"dependency_job_id":"a443f836-942a-4657-ad4d-cb27cc49b712","html_url":"https://github.com/skyzyx/alpine-pandoc","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skyzyx%2Falpine-pandoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skyzyx%2Falpine-pandoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skyzyx%2Falpine-pandoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skyzyx%2Falpine-pandoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/skyzyx","download_url":"https://codeload.github.com/skyzyx/alpine-pandoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":213547943,"owners_count":15603718,"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":["alpine-linux","container","docker","documentation","haskell","java","pandoc","plantuml","python","sphinx"],"created_at":"2024-08-01T16:00:46.467Z","updated_at":"2024-08-01T16:04:41.476Z","avatar_url":"https://github.com/skyzyx.png","language":"Dockerfile","funding_links":[],"categories":["Dockerfile"],"sub_categories":[],"readme":"# alpine-pandoc\n\n![MicroBadger Size (tag)](https://img.shields.io/microbadger/image-size/skyzyx/alpine-pandoc/1.2.0?style=for-the-badge)\n![MicroBadger Layers (tag)](https://img.shields.io/microbadger/layers/skyzyx/alpine-pandoc/1.2.0?style=for-the-badge)\n![Docker Pulls](https://img.shields.io/docker/pulls/skyzyx/alpine-pandoc?style=for-the-badge)\n![Docker Stars](https://img.shields.io/docker/stars/skyzyx/alpine-pandoc?style=for-the-badge)\n\nThis is the source code which builds a Docker container comprised of Alpine Linux, [Pandoc], and [PlantUML].\nIt is intended to provide an environment which is optimized for generating documentation.\n\nWe use:\n\n* [Pandoc] (Haskell) to convert [Markdown] into HTML, [reStructuredText] or PDF.\n* [PlantUML] (Java) to convert UML diagrams to SVG or PNG images.\n\n## Building the Container\n\n```bash\nmake\n```\n\n## Consuming the Container\n\nThe short version is `FROM skyzyx/alpine-pandoc:1.2.0`.\n\n1. Compiling Pandoc takes some time, so using this container saves you that time.\n1. Build your own container with your own specific dependencies using `RUN` commands.\n1. Use something like [Docker Compose] to mount your documentation source to `/var/docs`.\n1. Add your documentation-building task as an `ENTRYPOINT`.\n\n`docker-compose up` the first time (or with `--build`) will build your custom container, then run your `ENTRYPOINT` task.\nSubsequent runs of `docker-compose up` will only execute your `ENTRYPOINT` task.\n\n### Sample `Dockerfile`\n\n#### Using [Sphinx]\n\n```Dockerfile\nFROM skyzyx/alpine-pandoc:1.2.0\n\nENV PERSISTENT_DEPS wget git mercurial make openssh sphinx\nENV SPHINXBUILD /usr/bin/sphinx-build\nENV SPHINXOPTS -T\n\n# Copy Source code and set working directory\nCOPY src /var/docs\nWORKDIR /var/docs\n\nUSER root\n\nRUN apk add --no-cache --virtual .persistent-deps $PERSISTENT_DEPS\nRUN pip install -r requirements.txt\n\nENTRYPOINT [\"make\", \"docs\"]\n```\n\n#### Using [XeTeX] and [pandoc-plantuml-filter]\n\n```Dockerfile\nFROM skyzyx/alpine-pandoc:1.2.0\n\nUSER root\nENV DEPS \\\n    make \\\n    texlive-xetex\nRUN apk add --no-cache $DEPS \u0026\u0026 \\\n    pip install pandoc-plantuml-filter\n\nUSER pandoc\nENTRYPOINT [\"make\", \"docs\"]\n\n# make ultimately calls:\n#  pandoc --filter=pandoc-plantuml\n#         --output=out.pdf\n#         --from=markdown\n#         *.md\n```\n\n### Sample `docker-compose.yml`\n\n```yaml\nversion: \"3\"\nservices:\n    documentation-builder:\n        build: .\n        volumes:\n            - ./src:/var/docs\n```\n\n[Docker Compose]: https://docs.docker.com/compose/\n[Markdown]: http://commonmark.org\n[Pandoc]: http://pandoc.org\n[pandoc-plantuml-filter]: https://github.com/timofurrer/pandoc-plantuml-filter\n[PlantUML]: http://plantuml.com\n[reStructuredText]: http://docutils.sourceforge.net/rst.html\n[Sphinx]: http://www.sphinx-doc.org\n[XeTeX]: http://xetex.sourceforge.net/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskyzyx%2Falpine-pandoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskyzyx%2Falpine-pandoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskyzyx%2Falpine-pandoc/lists"}