You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ You do not *need* a separate GitHub Action.
20
20
If you need LaTeX (because you want to convert through to PDF), you should use the `docker://pandoc/latex` image.
21
21
Otherwise, the smaller `docker://pandoc/core` will suffice.
22
22
23
-
It is a good idea to be explicit about the pandoc version you require, such as `docker://pandoc/core:2.9`.
23
+
It is a good idea to be explicit about the pandoc version you require, such as `docker://pandoc/core:3.5`.
24
24
This way, any future breaking changes in pandoc will not affect your workflow.
25
25
You can find out whatever the latest released docker image is on [docker hub](https://hub.docker.com/r/pandoc/core/tags).
26
26
You should avoid specifying *no* tag or the `latest` tag -- these will float to the latest image and will expose your workflow to potentially breaking changes.
@@ -33,7 +33,7 @@ The string passed to `args` gets appended to the [`pandoc` command](https://pand
33
33
34
34
The below example is equivalent to running `pandoc --help`.
35
35
36
-
You can see it in action [here](http://github.com/maxheld83/pandoc-example).
36
+
You can see it in action [here](https://github.com/pandoc/pandoc-action-example).
37
37
38
38
```yaml
39
39
name: Simple Usage
@@ -44,7 +44,7 @@ jobs:
44
44
convert_via_pandoc:
45
45
runs-on: ubuntu-22.04
46
46
steps:
47
-
- uses: docker://pandoc/core:2.9
47
+
- uses: docker://pandoc/core:3.5
48
48
with:
49
49
args: "--help"# gets appended to pandoc command
50
50
```
@@ -54,7 +54,7 @@ jobs:
54
54
55
55
Remember that as per the [GitHub Actions workflow syntax](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepswithargs), "an `array of strings` is not supported by the `jobs.<job_id>.steps.with.args` parameter.
56
56
Pandoc commands can sometimes get quite long and unwieldy, but you must pass them as a *single* string.
57
-
If you want to break up the string over several lines, you can use YAML's [block chomping indicator](http://www.yaml.org/spec/1.2/spec.html#id2794534):
57
+
If you want to break up the string over several lines, you can use YAML's [block chomping indicator](https://yaml.org/spec/1.2.2/#8112-block-chomping-indicator):
58
58
59
59
```yaml
60
60
name: Long Usage
@@ -66,15 +66,15 @@ jobs:
66
66
runs-on: ubuntu-22.04
67
67
steps:
68
68
- run: echo "foo" > input.txt # create an example file
69
-
- uses: docker://pandoc/core:2.9
69
+
- uses: docker://pandoc/core:3.5
70
70
with:
71
71
args: >- # allows you to break string into multiple lines
72
72
--standalone
73
73
--output=index.html
74
74
input.txt
75
75
```
76
76
77
-
You can see it in action [here](http://github.com/maxheld83/pandoc-example).
77
+
You can see it in action [here](https://github.com/pandoc/pandoc-action-example).
78
78
79
79
80
80
## Advanced Usage
@@ -89,7 +89,7 @@ Only [GitHub Actions context and expression syntax](https://help.github.com/en/a
89
89
If you want to make use of such shell features, you have to run that in a separate step in a `run` field and store the result in the GitHub actions context.
90
90
The below workflow includes an example of how to do this to concatenate several input files.
91
91
92
-
You can see it in action (haha!) [here](http://github.com/maxheld83/pandoc-example).
92
+
You can see it in action (haha!) [here](https://github.com/pandoc/pandoc-action-example).
0 commit comments