{"id":20801880,"url":"https://github.com/philips-software/antora-site-action","last_synced_at":"2025-10-15T01:49:52.785Z","repository":{"id":259242717,"uuid":"876521205","full_name":"philips-software/antora-site-action","owner":"philips-software","description":"Antora Site Generator GitHub Action","archived":false,"fork":false,"pushed_at":"2025-03-18T13:23:42.000Z","size":29,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-18T14:29:06.204Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/philips-software.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-22T05:40:25.000Z","updated_at":"2025-03-18T13:23:25.000Z","dependencies_parsed_at":"2025-02-12T10:38:37.026Z","dependency_job_id":"5b678112-82a7-4b69-a265-985c757dd1e7","html_url":"https://github.com/philips-software/antora-site-action","commit_stats":null,"previous_names":["philips-software/antora-site-action"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philips-software%2Fantora-site-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philips-software%2Fantora-site-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philips-software%2Fantora-site-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philips-software%2Fantora-site-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/philips-software","download_url":"https://codeload.github.com/philips-software/antora-site-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248107574,"owners_count":21048959,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-17T18:24:56.404Z","updated_at":"2025-10-15T01:49:47.752Z","avatar_url":"https://github.com/philips-software.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Antora Site GitHub Action\n\n[![Docker Image](https://github.com/philips-software/antora-site-action/workflows/Image%20Build/badge.svg)](https://github.com/philips-software/antora-site-action/actions)\n[![Continuous Integration](https://github.com/philips-software/antora-site-action/workflows/CI/badge.svg)](https://github.com/philips-software/antora-site-action/actions)\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://choosealicense.com/licenses/mit/) \n\nGitHub action that can be used to generate the [Antora](https://antora.org/) site.\n\nSupported Antora version: *\u003e= 3.0.0*\n\nSupported rendering plugins: *asciidoctor-plantuml*, *asciidoctor-kroki*\n\nSupported extensions: *@antora/lunr-extension*\n\n## Parameters\n\nThe action accepts the following parameters:\n\n* `antora_playbook` -- that specifies the Antora playbook path within the repository\n* `site_sources_path` -- the path within `$GITHUB_WORKSPACE` from where to run the site generation\n* `antora_generator` -- Select antora generator for site\n* `antora_custom_generator_dependencies` -- Enable installing Antora dependencies when using a custom generator\n* `antora_additional_arguments` -- Pass customized arguments when running Antora\n\n## How to add this GitHub Action to your workflow\n\n``` yaml\nname: \"Generate site using antora site action\"\nuses: philips-software/antora-site-action@latest\nwith:\n    antora_playbook: antora-playbook.yml\n    # optional path within the repo, defaults to ${{github.workspace}}\n    site_sources_path: 'site-sources-folder'\n```\n\n## How to enable Lunr-extension for adding documentation search index\n\nWithin your playbook file, define lunr-extension requirement\n\n``` yaml\nantora:\n  extensions:\n  - require: '@antora/lunr-extension'\n```\n\n## Example: Complete site playbook example using extensions\n\n``` yaml\nsite:\n  title: Documentation Site\n  start_page: index.adoc\ncontent:\n  sources:\n    - url: ../../\n      branches: HEAD\n      start_path: documents/antora \nui:\n  bundle:\n    url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable\n    snapshot: true\n  supplemental_files: supplemental_ui # Custom UI folder, if you have one\nantora:\n  extensions:\n    - require: \"@antora/lunr-extension\"\nasciidoc:\n  attributes:\n    kroki-fetch-diagram: true # Enable fetching diagrams (UML etc..)\n  extensions:\n    - \"asciidoctor-kroki\"\n```\n\n## Changelog\n\nSee [CHANGELOG](CHANGELOG.md) for more info on what's been changed.\n\n## Maintainers\n\nSee [MAINTAINERS](MAINTAINERS.md)\n\n## Contributing\n\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits\u0026logoColor=white)](https://conventionalcommits.org)\n\nantora-site-action uses semantic versioning and conventional commits.\n\nPlease refer to our [CONTRIBUTING.md](CONTRIBUTING.md) guide when you want to contribute to this project.\n\n## License\n\nantora-site-action is licensed under the [MIT](https://choosealicense.com/licenses/mit/) license. See [LICENSE file](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphilips-software%2Fantora-site-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphilips-software%2Fantora-site-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphilips-software%2Fantora-site-action/lists"}