Jekyll AsciiDoc UI Extensions

Libraries

• Admonition Extension

  Enhances AsciiDoc admonition elements with truncation and semantic tags and icons.

• Asciidoctor Tabs

  The official Asciidoctor extension with performance similar to the tabbed-panes component. Enable this component to activate the Asciidoctor Tabs extension.

• Badge

  Turn any text element into a Bootstrap badge.

• Button

  Turn a link or span element into a button with Bootstrap styling.

• Card

  Transform an AsciiDoc block into a Bootstrap card component.

• Clipable

  Adds a “Copy” button with copy-to-clipboard functionality to designated elements/classes on the hover state.

• Code Highlight

  Universal syntax highlighting configuration for code listings.

• Code Truncate

  Optionally truncate code listings and literal blocks to a maximum number of lines, after which a "Show more" link will be displayed.

• Collapse

  Adds Bootstrap collapse functionality to sections of the document body.

• Content Typing System

  Adds a document type to the document body. This is a semantic tag that can be used to classify the document for search, navigation/architecture, display theming, and other purposes.

• GDPR Dialog

  Adds a GDPR-compliant cookie consent dialog to the site. The dialog is displayed to users on their first visit to the site, and can be dismissed or accepted.

  The dialog will not appear if there are no cookies listed.

• GDPR Enforce

  Keeps pages from planting cookies until/unless the user has accepted the cookie consent dialog.

  Adds a cookie called blocked-cookies that records the list of cookies not (yet) accepted by the user.

• Glossaries

  Adds glossary pages or documents to the site. The glossary page is a single page or series of pages listing and defining any terms added to the collection.

  Use config-terms-ext to auto-detect and classify terms in the document body.

• File Semantics

  Add the appropriate file icon to any mention of a file.

• Inline Term Semantics

  A term to highlight inline in the document body, optionally displaying or linking to a definition or description of that term.

• Literal Prompt

  Adds a prompt string to the beginning of a literal string or each line in a literal block.

• Literal Sudo Highlight

  For any line in a literal block that starts with sudo, wraps in a SPAN.sudo element.

• Property Handler

  Specially parses text designated with a role like ppty, indicating the content is to be treated like a reference to a property in the same reference context. Use the settings of ppty-ext to configure the syntax and behavior of this semantic.

• ReleaseHX

  Adds a release history page or document to the site. The release history a page or pages serializing the product releases as Release Notes and/or Changelog.

  ReleaseHX is configured in its own data file at site.data.ui.releasehx.

• Mardown Resourcer

  Generates an alternate Markdown file from the rendered HTML, reverse engineering back to a lightweight markup, especially designed for LLM (large language model) crawlers and RAG (retrieval-augmented generation) systems. Optionally (by default) reates a <link rel="alternate" type="text/markdown" href="/alt/markdown.md"> link in the document head.

• SEO Extension

  Detects specifically classed terms or phrases in the document body for use in the keywords meta tag for search-engine optimization (SEO). Writes directly to the head element of the document (not JavaScript).

• Sidebar Extension

  Enhances AsciiDoc sidebar elements with truncation and semantic tags and icons. Optionally adds a "move to" button to each sidebar block, allowing users to send the sidebar to the bottom of the page for later reading.

• Tabbed Panes

  Enables showing and hiding blocks of content in place, usually for switching between language-variant versions of the same data or code. See also asciidoctor-tabs.

• Term Extension

  Uses glossary data to proactively highlight (or not) any terms found on a given page. Adds wrapper elements and classes to the DOM where matching terms are found. See config-glossary and config-term for context.

• Theme Extension

  Adds theme files to calling project’s assets.

• Alternate Table of Contents

  Infers a ToC from your rendered headlines instead of using the built-in Asciidoctor ToC for a given page.

• Trademarker

  Handle trademark (™) symbols and trademarked terms.