npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

hexo-algoliasearch

v2.0.1

Published

A plugin to index posts of your Hexo blog on Algolia

Downloads

5,294

Readme

hexo-algoliasearch

npm version npm download/month code coverage

A plugin to index posts of your Hexo blog on Algolia

Installation

npm install hexo-algoliasearch --save

If Hexo detect automatically all plugins, that's all.

If that is not the case, register the plugin in your _config.yml file :

plugins:
  - hexo-algoliasearch

Configuration

You can configure this plugin in your _config.yml file :

algolia:
  appId: "Z7A3XW4R2I"
  apiKey: "12db1ad54372045549ef465881c17e743"
  adminApiKey: "40321c7c207e7f73b63a19aa24c4761b"
  chunkSize: 5000
  indexName: "my-hexo-blog"
  fields:
    - content:strip:truncate,0,500
    - excerpt:strip
    - gallery
    - permalink
    - photos
    - slug
    - tags
    - title

| Key | Type | Default | Description | | -------------- | ------ | ------- | ----------- | | appId | String | | Your application ID. Optional, if the environment variable ALGOLIA_APP_ID is set| | apiKey | String | | Your API key (read only). It is use to search in an index. Optional, if the environment variable ALGOLIA_API_KEY is set| | adminApiKey | String | | Your adminAPI key. It is use to create, delete, update your indexes. Optional, if the environment variable ALGOLIA_ADMIN_API_KEY is set | | chunkSize | Number | 5000 | Records/posts are split in chunks to upload them. Algolia recommend to use 5000 for best performance. Be careful, if you are indexing post content, It can fail because of size limit. To overcome this, decrease size of chunks until it pass. | | indexName | String | | The name of the index in which posts are stored. Optional, if the environment variable ALGOLIA_INDEX_NAME is set| | fields | List | | The list of the field names to index. Separate field name and filters with :. Read Filters for more information |

Filters

Filters give you the ability to process value of fields before indexation. Filters are separated each others by colons (:) and may have optional arguments separated by commas (,). Multiple filters can be chained. The output of one filter is applied to the next.

List of filters:

| Filter | Signature | Syntax | Description | | ---------- | -------------------------------------- | ---------------- | ----------- | | strip | strip() | strip | Strip HTML. It can be useful for excerpt and content value to not index HTML tags and attributes. | | truncate | truncate(start: number, end: number) | truncate,0,300 | Truncate string from start index to end index. Algolia has some limitations about record size so it might be useful to cut post contents. |

Example
  fields:
    - content:strip:truncate,0,200

It will strip HTML from content value then truncate the result starting from index 0 to index 200 before indexation. This property will be added to algolia records as contentStripTruncate

Usage

hexo algolia

Options

| Options | Description | | -------------- | ----------- | | -n, --no-clear | Does not clear the existing index |

Licence

hexo-algoliasearch is under MIT