kameshsampath/antora-site-action

Antora Site generator GitHub action

Hi there 👋

🔭 An Author, Consultant, Developer Advocate and Google Developer Expert(Modern Architecures). As part of my role I actively educate developers on Kubernetes/OpenShift, Servicemesh, and Serverless technologies. With a career spanning close to two decades, most of my career was with services industry helping various enterprise customers build Java-based solutions.

👯 I am a contributor to Open Source projects for more than a decade and contributed/contributing to projects

• k3d
• Tektoncd, Knative
• Minikube
• Apache Camel-K
• Wolfi OS

My developer philosophy LEARN MORE, DO MORE and SHARE MORE!

💬 Ask me about Argo CD, Istio, Knative, Tektoncd, Google Cloud

🌱 I’m currently learning golang and rust

Blogs

• https://blogs.kameshs.dev
• https://dev.to/kameshsampath

😄 He/Him/His

antora-site-action's Issues

Add doc search support

Thanks for sharing antora-site-action

I wonder if you are interested in extending the component to support Mogztter/antora-lunr. I would happily contribute to this.

A proposal for the action specification:

name: "Antora Site"
description: "Generate the Antora site"
branding:
  icon: book-open
  color: yellow
inputs:
  antora_playbook:
    description: 'The Antora playbook file'
    required: true
    default: 'site.yaml'
  site_sources_path:
    description: 'The path relative to workspace root, where the asciidoc sources exits'
    required: false
  antora_generator:
    description: 'Select generator to be used. Supports "@antora/site-generator-default" or "antora-site-generator-lunr"'
    required: false
    default: '@antora/site-generator-default'
  antora_search_bar_enabled:
    description: 'Select whether to enable the search bar for documentation'
    required: false
    default: 'false'
runs:
  using: 'docker'
  image: 'Dockerfile'
  args:
     - ${{ inputs.antora_playbook}}
     - ${{ inputs.site_sources_path }}
     - ${{ inputs.antora_generator }}
     - ${{ inputs.antora_search_bar_enabled }}

Happy to provide a PR if you find this reasonable.

Thanks again,
Fede

Touch .nojekyll

It would be really cool if this action would verify that there is a .nojekyll file present in the published site. We know that Jekyll interferes with the output generated by Antora, so we will always need it when publishing to GitHub Pages. It would make things a lot simpler for users if the action took care of this detail.