Data

Tools

Indexes

Applications

Experiments

Open Source Science

dieghernan/algolia-jekyll-action

Runs jekyll-algolia plugin for GitHub Pages

https://github.com/dieghernan/algolia-jekyll-action

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.6%) to scientific vocabulary

Keywords

algolia algolia-instantsearch algolia-search github-actions github-pages github-pages-website jekyll ruby search

Keywords from Contributors

interactive mesh interpretability profiles attribution sequences generic projection standardization optim
Last synced: 4 months ago · JSON representation ·

Repository

Runs jekyll-algolia plugin for GitHub Pages

Basic Info
Statistics
  • Stars: 7
  • Watchers: 2
  • Forks: 7
  • Open Issues: 2
  • Releases: 3
Topics
algolia algolia-instantsearch algolia-search github-actions github-pages github-pages-website jekyll ruby search
Created almost 5 years ago · Last pushed 5 months ago
Metadata Files
Readme Funding License Citation

README.md

algolia-jekyll-action

latest-version gh-pages jekyll ruby

This is a wrapper of the jekyll-algolia plugin.

🎉 GitHub Pages ready!

This action pushes all your content in an Algolia index.

Repo setup

Full reference on the jekyll-algolia documentation.

A. Install jekyll-algolia

  1. On your Algolia account (free Community plan available), get your credentials from your dashboard.

  2. On your _config.yml, write:

```yaml

algolia: applicationid: YOURAPPLICATIONID indexname: YOURINDEXNAME # You can replace that with whatever name you want searchonlyapikey: YOURSEARCHONLYAPI_KEY

```

  1. Add jekyll-algolia to your Gemfile, as part of the :jekyll-plugins group.

```ruby source 'https://rubygems.org' gem 'jekyll', '~> 3.6'

group :jekyll_plugins do gem 'jekyll-algolia' end ```

  1. Important: On your GitHub repo, go to Settings > Secrets and set a new secret:

| Name | Value | | --- | --- | | ALGOLIA_API_KEY | YOUR_ADMIN_API_KEY |

B. Create a GitHub Action

Create a workflow file (e.g. algolia-search.yml) in your-repo/.github/workflows/ directory, similar to:

``` yaml on: push: branches: - master - main

name: algolia-search jobs: algolia-search: runs-on: ubuntu-latest env: JEKYLLGITHUBTOKEN: ${{ secrets.GITHUBTOKEN }} steps: - uses: actions/checkout@v3 - name: Algolia Jekyll Action uses: dieghernan/algolia-jekyll-action@main with: APIKEY: '${{ secrets.ALGOLIAAPI_KEY }}'

```

This action would run on every commit on the main/master. For more trigger events see this link.

Inputs available

  • APIKEY: Required. It is better to use GitHub Secrets (see above) instead the actual value on the action, for security reasons.
  • ruby-version: Version of Ruby to use on build. Default is '2.6'.
  • cache-version: default 1. If you need to invalidate the existing cache pass any other number and a new cache will be used.
  • jekyll_src: default "". Jekyll website source directory. Use it if the source of your site is in a subfolder (e.g docs, etc.).

Disclaimer

This software is in no way officially related to or endorsed by Algolia.

Owner

  • Name: Diego H.
  • Login: dieghernan
  • Kind: user
  • Location: Madrid, ES

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software in your research, please cite it as below."
title: "algolia-jekyll-action"
version: "v2.1"
doi: "10.5281/zenodo.7239226"
date-released: "2022-10-22"
abstract: "Runs jekyll-algolia plugin for GitHub Pages."
authors:
- family-names: "Hernangómez"
  given-names: "Diego"
  orcid: "https://orcid.org/0000-0001-8457-4658"
license: MIT
url: "https://github.com/marketplace/actions/algolia-jekyll-action"
repository-code: "https://github.com/dieghernan/algolia-jekyll-action"
keywords:
  - algolia
  - algolia-instantsearch
  - algolia-search
  - github-actions
  - github-pages
  - github-pages-website
  - jekyll
  - ruby
  - search

GitHub Events

Total
  • Issue comment event: 3
  • Push event: 1
  • Pull request event: 4
  • Create event: 1
Last Year
  • Issue comment event: 3
  • Push event: 1
  • Pull request event: 4
  • Create event: 1

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 19
  • Total Committers: 2
  • Avg Commits per committer: 9.5
  • Development Distribution Score (DDS): 0.105
Past Year
  • Commits: 2
  • Committers: 2
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.5
Top Committers
Name Email Commits
dieghernan d****o@g****m 17
dependabot[bot] 4****] 2

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 2
  • Total pull requests: 5
  • Average time to close issues: about 19 hours
  • Average time to close pull requests: about 1 month
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 2.5
  • Average comments per pull request: 1.0
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 4
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: about 10 hours
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.5
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 2
View more stats
Top Authors
Issue Authors
  • mzagaja (1)
  • fossabot (1)
  • sunete (1)
Pull Request Authors
  • dependabot[bot] (5)
  • dieghernan (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (5) github_actions (1)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 13
  • Total versions: 4
github actions: dieghernan/algolia-jekyll-action

Run jekyll-algolia plugin

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 13
Rankings
Dependent packages count: 0.0%
Average: 8.4%
Forks count: 9.5%
Dependent repos count: 11.0%
Stargazers count: 13.1%
Last synced: 4 months ago

Dependencies

.github/workflows/cff-validator.yml actions
  • actions/checkout v3 composite
  • dieghernan/cff-validator main composite
action.yml actions
  • ruby/setup-ruby v1 composite