GitHub Action to Convert Documents via Pandoc

This action lets you use pandoc, the swiss army knife of document conversion.

It is based on the pandoc/latex docker image and thus ships with LaTeX, so you can also convert right through to PDF. The action currently uses pandoc 2.6 and will be upgrade periodically.

Secrets

None.

Environment Variables

• OUT_DIR (optional) a path relative from workspace/github (~ your repository root) without trailing slash.

  It's often useful to have pandoc output to a separate directory, for example for easier deployment. You can create such a directory using the OUT_DIR environment variable.

  If you've set it, the directory will be mkdired. Remember to point the output argument of your pandoc call in the args section to this new directory.

Arguments

All arguments get appended to the pandoc command.

Example Usage

This is the action block used to render the website for this action.

action "Convert" {
  uses = "maxheld83/[email protected]"
  env = {
    OUT_DIR = "public"
  }
  args = [
    "--standalone",
    "--output=public/index.html",
    "README.md"
  ]
}