https://github.com/adapttive/algolia-docsearch-action

Algolia Docsearch GitHub Action
https://github.com/adapttive/algolia-docsearch-action

algolia algolia-docsearch-action github-actions scraper

Last synced: 4 days ago
JSON representation

Algolia Docsearch GitHub Action

• Host: GitHub
• URL: https://github.com/adapttive/algolia-docsearch-action
• Owner: adapttive
• License: mit
• Created: 2021-03-14T09:24:07.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-30T04:04:04.000Z (over 2 years ago)
• Last Synced: 2024-09-25T15:37:51.881Z (8 days ago)
• Topics: algolia, algolia-docsearch-action, github-actions, scraper
• Language: Dockerfile
• Homepage: https://github.com/marketplace/actions/algolia-docsearch-action
• Size: 11.7 KB
• Stars: 11
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# algolia-docsearch-action

Algolia Docsearch Action

## Usage

- sample action config for your project:

```yaml

name: Algolia Indexer

on:

  push:

    branches: [ live ]

jobs:

  algolia_indexer:

    runs-on: ubuntu-latest

    env:

      APPLICATION_ID: {{YOUR_APP_ID}}

      API_KEY: {{YOUR_API_KEY_WITH_WRITE_PERMISSIONS}}

      INDEX_NAME: {{YOUR_WEBSITE}} # example.com

      CONFIG: '{"index_name":"example.com","start_urls":[{"url":"https://example.com/blog","selectors_key":"blog"}],"selectors":{"blog":{"lvl0":"h1","lvl1":"h2","lvl2":"h3","lvl3":"h4","lvl4":"h5","lvl5":"#description","text":"#content"}}}'

    name: Index Algolia

    steps:

    - name: Algolia Docsearch Action

      id: algolia

      uses:  adapttive/[email protected]

```