DocOps / liquidoc-gem

The canonical gem source for LiquiDoc, a ruby-based documentation parsing and rendering utility enabling advanced builds with Asciidoctor, Jekyll, Liquid, and semi-structured data files.
https://docs.docops.org/liquidoc-user-manual.html
MIT License
12 stars 5 forks source link

Integrate Algolia search indexing #48

Closed briandominick closed 6 years ago

briandominick commented 6 years ago

This PR facilitates the integration of Algolia search indexing of Jekyll sites sourced in AsciiDoc. This just carries over functionality already provided by the jekyll-algolia plugin. Again, LiquiDoc is just wrapping existing functionality, baking it into the LiquiDoc config structure, command-line arguments, and then triggering the functionality where appropriate. The config structure is intended to be "generic", and I would love to see it extended to other services, like Swiftype or maybe self-hosted Solr or Elastic solutions. But for my and my client market's purposes, I'm confident that Algolia is a great solution. Their free/community tier plan is excellent, and they approach software in a way I appreciate.

This patch does not facilitate the search query and result handling on your site. That is a theming issue to be handled in your site layout templates. I will be posing a tutorial/demo for this soon, but the clue is Algolia's Instantsearch offering.