https://github.com/philips-software/antora-site-action
Antora Site Generator GitHub Action
https://github.com/philips-software/antora-site-action
Last synced: 9 months ago
JSON representation
Antora Site Generator GitHub Action
- Host: GitHub
- URL: https://github.com/philips-software/antora-site-action
- Owner: philips-software
- License: mit
- Created: 2024-10-22T05:40:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-18T13:23:42.000Z (over 1 year ago)
- Last Synced: 2025-03-18T14:29:06.204Z (over 1 year ago)
- Language: Shell
- Size: 28.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Antora Site GitHub Action
[](https://github.com/philips-software/antora-site-action/actions)
[](https://github.com/philips-software/antora-site-action/actions)
[](https://choosealicense.com/licenses/mit/)
GitHub action that can be used to generate the [Antora](https://antora.org/) site.
Supported Antora version: *>= 3.0.0*
Supported rendering plugins: *asciidoctor-plantuml*, *asciidoctor-kroki*
Supported extensions: *@antora/lunr-extension*
## Parameters
The action accepts the following parameters:
* `antora_playbook` -- that specifies the Antora playbook path within the repository
* `site_sources_path` -- the path within `$GITHUB_WORKSPACE` from where to run the site generation
* `antora_generator` -- Select antora generator for site
* `antora_custom_generator_dependencies` -- Enable installing Antora dependencies when using a custom generator
* `antora_additional_arguments` -- Pass customized arguments when running Antora
## How to add this GitHub Action to your workflow
``` yaml
name: "Generate site using antora site action"
uses: philips-software/antora-site-action@latest
with:
antora_playbook: antora-playbook.yml
# optional path within the repo, defaults to ${{github.workspace}}
site_sources_path: 'site-sources-folder'
```
## How to enable Lunr-extension for adding documentation search index
Within your playbook file, define lunr-extension requirement
``` yaml
antora:
extensions:
- require: '@antora/lunr-extension'
```
## Example: Complete site playbook example using extensions
``` yaml
site:
title: Documentation Site
start_page: index.adoc
content:
sources:
- url: ../../
branches: HEAD
start_path: documents/antora
ui:
bundle:
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
snapshot: true
supplemental_files: supplemental_ui # Custom UI folder, if you have one
antora:
extensions:
- require: "@antora/lunr-extension"
asciidoc:
attributes:
kroki-fetch-diagram: true # Enable fetching diagrams (UML etc..)
extensions:
- "asciidoctor-kroki"
```
## Changelog
See [CHANGELOG](CHANGELOG.md) for more info on what's been changed.
## Maintainers
See [MAINTAINERS](MAINTAINERS.md)
## Contributing
[](https://conventionalcommits.org)
antora-site-action uses semantic versioning and conventional commits.
Please refer to our [CONTRIBUTING.md](CONTRIBUTING.md) guide when you want to contribute to this project.
## License
antora-site-action is licensed under the [MIT](https://choosealicense.com/licenses/mit/) license. See [LICENSE file](LICENSE).