https://github.com/thesis/asciidoctor-action
GitHub Action to compile asciidoctor files with mermaid diagrams
https://github.com/thesis/asciidoctor-action
Last synced: 9 months ago
JSON representation
GitHub Action to compile asciidoctor files with mermaid diagrams
- Host: GitHub
- URL: https://github.com/thesis/asciidoctor-action
- Owner: thesis
- License: mit
- Created: 2020-05-29T16:28:18.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-16T13:26:45.000Z (over 2 years ago)
- Last Synced: 2025-04-23T07:55:24.214Z (about 1 year ago)
- Language: Shell
- Size: 33.2 KB
- Stars: 3
- Watchers: 15
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE
Awesome Lists containing this project
README
= GitHub Asciidoctor Action
This action runs asciidoctor as requested, and includes mermaid and
asciidoctor-diagram for diagram handling.
== Inputs
`files` (**required**)::
A set of files to parse. This can include globs like `*.adoc`, as well as
multiglobs like `**/*.adoc`.
`format`::
Optional, can be set to `pdf` to use `asciidoctor-pdf`. If set to anything
other than `pdf`, currently the action just runs `asciidoctor` with no
other changes.
`asciidoctor-args`::
Optional, can be set to additional arguments that should be passed to the
`asciidoctor` or `asciidoctor-pdf` commands.
== Outputs
`asciidoctor-artifacts`::
A space-separated list of fully-resolved paths to artifacts generated by
the asciidoc compile.
== Example Usage
```
uses: thesis/asciidoctor-action@v1
with:
files: *.adoc **/*.adoc
```