An open API service indexing awesome lists of open source software.

https://github.com/leplusorg/docker-adoc

Multi-platform Docker container with utilities to process AsciiDoc files (asciidoc, a2x, ascidoctor...).
https://github.com/leplusorg/docker-adoc

asciidoc asciidoctor asciidoctor-converter docker docker-container docker-image dockerfile

Last synced: 15 days ago
JSON representation

Multi-platform Docker container with utilities to process AsciiDoc files (asciidoc, a2x, ascidoctor...).

Awesome Lists containing this project

README

          

# AsciiDoc

Multi-platform Docker container with utilities to process AsciiDoc files (`asciidoc`, `a2x`, `ascidoctor`...).

[![Dockerfile](https://img.shields.io/badge/GitHub-Dockerfile-blue)](adoc/Dockerfile)
[![Docker Build](https://github.com/leplusorg/docker-adoc/workflows/Docker/badge.svg)](https://github.com/leplusorg/docker-adoc/actions?query=workflow:"Docker")
[![Docker Stars](https://img.shields.io/docker/stars/leplusorg/adoc)](https://hub.docker.com/r/leplusorg/adoc)
[![Docker Pulls](https://img.shields.io/docker/pulls/leplusorg/adoc)](https://hub.docker.com/r/leplusorg/adoc)
[![Docker Version](https://img.shields.io/docker/v/leplusorg/adoc?sort=semver)](https://hub.docker.com/r/leplusorg/adoc)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/10081/badge)](https://bestpractices.coreinfrastructure.org/projects/11218)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/leplusorg/docker-adoc/badge)](https://securityscorecards.dev/viewer/?uri=github.com/leplusorg/docker-adoc)

## Example without using the filesystem

Let's say that you want to convert an AsciiDoc file intput.adoc in your current working directory to HTML:

**Mac/Linux**

```bash
cat intput.adoc | docker run --rm -i --net=none leplusorg/adoc asciidoctor -o - - > output.html
```

**Windows**

```batch
type intput.adoc | docker run --rm -i --net=none leplusorg/adoc asciidoctor -o - - > output.html
```

## Example using the filesystem

Same thing, assuming that you want to convert an AsciiDoc file intput.adoc in your current working directory to HTML:

**Mac/Linux**

```bash
docker run --rm -t --user="$(id -u):$(id -g)" --net=none -v "$(pwd):/tmp" leplusorg/adoc asciidoctor -o output.html intput.adoc
```

**Windows**

In `cmd`:

```batch
docker run --rm -t --net=none -v "%cd%:/tmp" leplusorg/adoc asciidoctor -o output.html intput.adoc
```

In PowerShell:

```pwsh
docker run --rm -t --net=none -v "${PWD}:/tmp" leplusorg/adoc asciidoctor -o output.html intput.adoc
```

## Software Bill of Materials (SBOM)

To get the SBOM for the latest image (in SPDX JSON format), use the
following command:

```bash
docker buildx imagetools inspect leplusorg/adoc --format '{{ json (index .SBOM "linux/amd64").SPDX }}'
```

Replace `linux/amd64` by the desired platform (`linux/amd64`, `linux/arm64` etc.).

### Sigstore

[Sigstore](https://docs.sigstore.dev) is trying to improve supply
chain security by allowing you to verify the origin of an
artifcat. You can verify that the image that you use was actually
produced by this repository. This means that if you verify the
signature of the Docker image, you can trust the integrity of the
whole supply chain from code source, to CI/CD build, to distribution
on Maven Central or whever you got the image from.

You can use the following command to verify the latest image using its
sigstore signature attestation:

```bash
cosign verify leplusorg/adoc --certificate-identity-regexp 'https://github\.com/leplusorg/docker-adoc/\.github/workflows/.+' --certificate-oidc-issuer 'https://token.actions.githubusercontent.com'
```

The output should look something like this:

```text
Verification for index.docker.io/leplusorg/xml:main --
The following checks were performed on each of these signatures:
- The cosign claims were validated
- Existence of the claims in the transparency log was verified offline
- The code-signing certificate was verified using trusted certificate authority certificates

[{"critical":...
```

For instructions on how to install `cosign`, please read this [documentation](https://docs.sigstore.dev/cosign/system_config/installation/).

## Request new tool

Please use [this link](https://github.com/leplusorg/docker-adoc/issues/new?assignees=thomasleplus&labels=enhancement&template=feature_request.md&title=%5BFEAT%5D) (GitHub account required) to request that a new tool be added to the image. I am always interested in adding new capabilities to these images.