Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Cassandra's branch: https://github.com/ctargett/solr/tree/antora-migration/solr/solr-ref-guide (does not yet remove all vestiges of Jekyll and the repo path would only work on my machineJekyl)

Table of Contents

Antora Design Goals

...

As of version 3 of Antora (TBD, in the works), we will be able to refer to an expanded directory of UI files instead of a .zip.

UI Design Changes

Some notes

The default UI of Antora does not include Bootstrap, which is probably a good thing. The main thing we use Bootstrap for today is the tabs layout on pages such as https://solr.apache.org/guide/configsets-api.html#configsets-list. There is an Antora extension to do the same thing: https://gitlab.com/antora/antora-asciidoctor-extensions/-/tree/master/tabs-block, which may be a viable alternative. Would need to add it as an extension in our playbook.

Misc Notes

  • Source highlighting only available through highlight.js
  • STEM support needs to be added to the UI (it's not OOTB) because it relies on MathJax

...