Skip to content

Commit f3599b1

Browse files
committed
build: initial commit
1 parent 12c0cb1 commit f3599b1

File tree

3 files changed

+19
-6
lines changed

3 files changed

+19
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# reStructuredText
22

3-
Multi-platform Docker container with utilities to process reStructuredText files (`docutils`, `rst2pdf`...).
3+
Multi-platform Docker container with utilities to process reStructuredText files (`docutils`, `pandoc`, `rst2pdf`...).
44

55
[![Dockerfile](https://img.shields.io/badge/GitHub-Dockerfile-blue)](rst/Dockerfile)
66
[![Docker Build](https://github.com/leplusorg/docker-rst/workflows/Docker/badge.svg)](https://github.com/leplusorg/docker-rst/actions?query=workflow:"Docker")
@@ -17,13 +17,13 @@ Let's say that you want to convert an reStructuredText file intput.rst in your c
1717
**Mac/Linux**
1818

1919
```bash
20-
cat intput.rst | docker run --rm -i --net=none leplusorg/rst asciidoc -o - > output.html
20+
cat intput.rst | docker run --rm -i --net=none leplusorg/rst pandoc -f markdown -t html - > output.html
2121
```
2222

2323
**Windows**
2424

2525
```batch
26-
type intput.rst | docker run --rm -i --net=none leplusorg/rst asciidoc -o - > output.html
26+
type intput.rst | docker run --rm -i --net=none leplusorg/rst pandoc -f markdown -t html - > output.html
2727
```
2828

2929
## Example using the filesystem
@@ -33,21 +33,21 @@ Same thing, assuming that you want to convert an reStructuredText file intput.rs
3333
**Mac/Linux**
3434

3535
```bash
36-
docker run --rm -t --user="$(id -u):$(id -g)" --net=none -v "$(pwd):/tmp" leplusorg/rst asciidoc -o output.html intput.rst
36+
docker run --rm -t --user="$(id -u):$(id -g)" --net=none -v "$(pwd):/tmp" leplusorg/rst pandoc -f markdown -t html -o output.html intput.rst
3737
```
3838

3939
**Windows**
4040

4141
In `cmd`:
4242

4343
```batch
44-
docker run --rm -t --net=none -v "%cd%:/tmp" leplusorg/rst asciidoc -o output.html intput.rst
44+
docker run --rm -t --net=none -v "%cd%:/tmp" leplusorg/rst pandoc -f markdown -t html -o output.html intput.rst
4545
```
4646

4747
In PowerShell:
4848

4949
```pwsh
50-
docker run --rm -t --net=none -v "${PWD}:/tmp" leplusorg/rst asciidoc -o output.html intput.rst
50+
docker run --rm -t --net=none -v "${PWD}:/tmp" leplusorg/rst pandoc -f markdown -t html -o output.html intput.rst
5151
```
5252

5353
## Software Bill of Materials (SBOM)

rst/Dockerfile

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,20 @@ RUN apk upgrade --no-cache \
1616
coreutils=9.7-r1 \
1717
curl=8.14.1-r1 \
1818
git=2.49.1-r0 \
19+
pandoc-cli=3.6.4-r0 \
20+
pipx=1.7.1-r0 \
21+
py3-docutils=0.21.2-r0 \
1922
py3-pip=25.1.1-r0 \
2023
python3=3.12.11-r0 \
2124
&& apk cache --no-cache clean \
2225
&& rm -rf /var/cache/apk/*
2326

27+
RUN pipx ensurepath --global \
28+
&& pipx install --global \
29+
docutils==0.22.2 \
30+
rstcheck==6.2.5 \
31+
rst2pdf==0.103.1
32+
2433
RUN adduser \
2534
--home "${USER_HOME}" \
2635
--uid "${USER_ID}" \

rst/docker-compose.test.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@ services:
1313
fi
1414
base64 --version # coreutils
1515
curl --version # curl
16+
docutils --version # docutils
1617
git --version # git
18+
pandoc --version # pandoc
1719
pip --version # py3-pip
1820
python --version # python3
21+
rst2pdf --version # rst2pdf
22+
rstcheck --version # rstcheck
1923
'

0 commit comments

Comments
 (0)