oxygenxml-incubator / webhelp-search-service-publishing-template

WebHelp publishing template to demonstrates how to integrate a search service with WebHelp transformation.

WebHelp Search Service Publishing Template

We'll create a publishing template to demonstrates how to integrate a search service with WebHelp transformation.

The project documentation is available here.

Project Outline:

1. How to replace internal WebHelp search engine with Algolia?
   

   • Create an Algolia index by crawling a WebHelp documentation
     
   • Setup searchable attributes and ranking criteria
     
   • Highlight matching words enhancement
     
   • Change search engine in Webhelp template
     
   • Replace short description with a snippet of matching words enhancement
     
   • Integrate Algolia Autocomplete widget in WebHelp transformation
     

2. How to replace search result presentation to add filter capabilities?
   

   • Update Algolia Crawler to index profiling conditions
     
   • Setup a React application to implement results presentation
     
   • Add filter component in search page
     
   • Publishing template to search over multiple documentation
     
   • Add support for labels/tags in WebHelp pages
     
   • Add breadcrumb to results
     

3. Continous publishing with GitHub Actions and Netlify

Example with profiling values from DITA is available here.
Example with multiple documentations is available here.

Copyright and License

Copyright 2022 Syncro Soft, SRL.

This project is licensed under Apache License 2.0