Skip to content

Render and upload markdown docs to Algolia

License

Notifications You must be signed in to change notification settings

opstrace/algolia-docs-sync

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Algolia-Docs-Sync

Semantic Release

Inputs

algoliaId

Required Algolia Application ID

algoliaKey

Required Algolia Admin Key (not readonly)

algoliaIndex

Required Algolia Index to write to

Example usage

name: Sync Algolia

on:
  push:
    branches:
      - 'main'

jobs:
  algolia:
    runs-on: ubuntu-latest
    name: Algolia Sync
    steps:
      - uses: actions/checkout@v2

      - uses: opstrace/algolia-docs-sync@v1.0.2
        with:
          algoliaId: 'QTVPN6XDU8'
          algoliaKey: ${{ secrets.ALGOLIA_KEY }}
          algoliaIndex: 'opstrace-test'