Implementation documentation

[kzdelarec]

Can you please provide implementation docs?

[JeanMarcCoic]

Hi Kristijan,

This library is only one building block to index an antora website in Elastic search. You will have to write additional code to integrate the library. I can think of at least :

• add the library in your package.json
• your own antora site generator by forking the site-generator-default package to pass the pages variable to the indexer, for example:

 const mapSite = require('@antora/site-mapper')
 const produceRedirects = require('@antora/redirect-producer')
 const publishSite = require('@antora/site-publisher')
+const siteIndexer = require('antora-indexer-elasticsearch')
 const { resolveConfig: resolveAsciiDocConfig } = require('@antora/asciidoc-loader')

 async function generateSite (args, env) {
@@ -20,6 +21,7 @@
   ])
   const asciidocConfig = resolveAsciiDocConfig(playbook)
   const pages = convertDocuments(contentCatalog, asciidocConfig)
+  siteIndexer(pages)
   const navigationCatalog = buildNavigation(contentCatalog, asciidocConfig)
   const composePage = createPageComposer(playbook, contentCatalog, uiCatalog, env)
   pages.forEach((page) => composePage(page, contentCatalog, navigationCatalog))

• the library doesn't support any configuration yet, so you will have to modify the elastic search host and index path directly in your own fork of the library
• you need to specify your new generator by using the --generator option to antora generate
• then you need to implement your own search component in your antora UI

And your ask of more documentation is totally legitimate, we need to work on this in the future.

Jean-Marc