{"id":13474015,"url":"https://github.com/maxheld83/pandoc-action","last_synced_at":"2025-03-26T20:30:38.212Z","repository":{"id":65160843,"uuid":"171844778","full_name":"maxheld83/pandoc-action","owner":"maxheld83","description":"github action to run pandoc, soft-deprecated -\u003e","archived":true,"fork":false,"pushed_at":"2019-12-21T20:42:04.000Z","size":5105,"stargazers_count":42,"open_issues_count":0,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-30T06:33:54.015Z","etag":null,"topics":["continuous-delivery","github-actions","html","latex","markdown","pandoc"],"latest_commit_sha":null,"homepage":"https://github.com/maxheld83/pandoc-action-example","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maxheld83.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}},"created_at":"2019-02-21T09:48:06.000Z","updated_at":"2024-10-11T16:25:20.000Z","dependencies_parsed_at":"2023-01-04T12:38:33.205Z","dependency_job_id":null,"html_url":"https://github.com/maxheld83/pandoc-action","commit_stats":{"total_commits":42,"total_committers":1,"mean_commits":42.0,"dds":0.0,"last_synced_commit":"acb01427a806f2ab883ac6a093d96a0ac77c10b1"},"previous_names":["maxheld83/pandoc"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxheld83%2Fpandoc-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxheld83%2Fpandoc-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxheld83%2Fpandoc-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maxheld83%2Fpandoc-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maxheld83","download_url":"https://codeload.github.com/maxheld83/pandoc-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245731148,"owners_count":20663130,"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":["continuous-delivery","github-actions","html","latex","markdown","pandoc"],"created_at":"2024-07-31T16:01:08.841Z","updated_at":"2025-03-26T20:30:37.108Z","avatar_url":"https://github.com/maxheld83.png","language":null,"funding_links":[],"categories":["Community Resources"],"sub_categories":["Utility"],"readme":"# GitHub Action to Convert Documents via Pandoc\n\n\u003c!-- badges: start --\u003e\n[![Actions Status](https://github.com/maxheld83/pandoc-action/workflows/Document%20Conversion/badge.svg)](https://github.com/maxheld83/pandoc-action/actions)\n\u003c!-- badges: end --\u003e\n\n## Soft-Deprecation: Better Alternatives\n\n**This action is soft-deprecated, because you no longer need it.**\n\n**This action will remain listed, but will no longer receive major updates**.\n\nThere are now two better ways to use pandoc on GitHub Actions:\n\n### Container Actions\n\nYou can now *directly* [reference container actions](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/configuring-a-workflow#referencing-a-container-on-docker-hub) on GitHub Actions.\n\nYou can continue to use the [pandoc containers](https://github.com/maxheld83/pandoc/issues/16) on GitHub Actions, but now you can just reference it by, say, `uses: docker://pandoc/latex:2.9` instead of `uses: maxheld83/pandoc@v2`.\n\nTo learn more about using pandoc on GitHub Actions in this way, see these [examples](https://github.com/maxheld83/pandoc-example).\n\n\n### `setup-pandoc` Action\n\nIn the above, you're using pandoc from a pre-build docker image, that you're running as a *container* on your GitHub Actions host machine.\n\nAlternatively, you can use [Jim Hester](https://www.jimhester.com)'s [setup-pandoc](https://github.com/r-lib/actions/tree/master/setup-pandoc) action.\nThis action will accept a `pandoc-version` as an input and install the respective version directly into your GitHub Actions *host machine*.\nThis may take longer (?), and does not include LaTeX, but you can use pandoc in any of your steps and can even run a matrix build over different pandoc versions.\n\n\n----\n\nThis action lets you use [pandoc](https://pandoc.org/), the **swiss army knife of document conversion**.\n\nIt is based on the [`pandoc/latex`](https://hub.docker.com/r/pandoc/latex/) docker image and thus ships with LaTeX, so you can also convert right through to PDF.\n\nThe action currently uses pandoc 2.6 ~~and will be upgraded periodically.\nIf you would like to see an upgrade, please [file an issue](http://github.com/maxheld83/pandoc/issues).~~\n\n\n## Inputs\n\nNone.\n\n\n## Outputs\n\nNone.\n\n\n## Secrets\n\nNone.\n\n\n## Environment Variables\n\nNone.\n\n\n## Example Usage\n\nThe string passed to `args` gets appended to the [`pandoc` command](https://pandoc.org/MANUAL.html).\nThe below example is equivalent to running `pandoc --help`.\n\n```\nname: Document Conversion\n\non: push\n\njobs:\n  convert_via_pandoc:\n    name: Convert via Pandoc\n    runs-on: ubuntu-18.04\n    steps:\n      - uses: actions/checkout@v1\n      - uses: maxheld83/pandoc@v2\n        with:\n          args: \"--help\"\n```\n\n\n## Advanced Usage\n\nYou can:\n\n- create an output directory to compile into; makes it easier to deploy outputs.\n- upload the output directory to [GitHub's artifact storage](https://help.github.com/en/articles/managing-a-workflow-run#downloading-logs-and-artifacts); you can quickly download the results from your GitHub Actions tab in your repo.\n\n```\nname: Document Conversion\n\non: push\n\njobs:\n  convert_via_pandoc:\n    name: Convert via Pandoc\n    runs-on: ubuntu-18.04\n    steps:\n      - uses: actions/checkout@v1\n      - run: mkdir output\n      - run: echo \"foo\" \u003e input.txt\n      - uses: maxheld83/pandoc@v2\n        with:\n          args: \"--standalone --output=output/index.html input.txt\"\n      - uses: actions/upload-artifact@master\n        with:\n          name: output\n          path: output\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxheld83%2Fpandoc-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaxheld83%2Fpandoc-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaxheld83%2Fpandoc-action/lists"}