RubyGems - apex-ruby - Versions diffs - 1.0.18 → 1.0.20 - Mend

apex-ruby 1.0.18 → 1.0.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (207) hide show

data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Indices.html ADDED Viewed

@@ -0,0 +1,2327 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+      <meta charset="UTF-8">
+      <meta name="viewport" content="width=device-width, initial-scale=1.0">
+      <meta name="generator" content="Apex 1.1.12">
+      <title>Document</title>
+      <style>
+        /* GitHub-style syntax highlighting for Pygments and Skylighting */
+        /* Don't apply background to wrapper when code highlighting is enabled - let default styles handle it */
+        .code-highlighted .highlight, .code-highlighted .sourceCode { background: inherit; border-radius: 6px; padding: 16px; overflow-x: auto; }
+        .highlight pre, .sourceCode pre { margin: 0; padding: 0; background: transparent; }
+        .highlight code, .sourceCode code { font-family: 'SFMono-Regular', Consolas, 'Liberation Mono', Menlo, monospace; font-size: 12px; line-height: 1.45; }
+        /* Pygments classes */
+        .highlight .k { color: #d73a49; font-weight: 600; } /* Keyword */
+        .highlight .kt { color: #d73a49; } /* Keyword.Type */
+        .highlight .kd { color: #d73a49; font-weight: 600; } /* Keyword.Declaration */
+        .highlight .kn { color: #d73a49; } /* Keyword.Namespace */
+        .highlight .kp { color: #d73a49; } /* Keyword.Pseudo */
+        .highlight .kr { color: #d73a49; font-weight: 600; } /* Keyword.Reserved */
+        .highlight .n { color: #6f42c1; } /* Name */
+        .highlight .na { color: #6f42c1; } /* Name.Attribute */
+        .highlight .nc { color: #6f42c1; font-weight: 600; } /* Name.Class */
+        .highlight .no { color: #005cc5; } /* Name.Constant */
+        .highlight .nd { color: #6f42c1; font-weight: 600; } /* Name.Decorator */
+        .highlight .ni { color: #800080; } /* Name.Entity */
+        .highlight .ne { color: #990000; font-weight: 600; } /* Name.Exception */
+        .highlight .nf { color: #6f42c1; font-weight: 600; } /* Name.Function */
+        .highlight .nl { color: #6f42c1; } /* Name.Label */
+        .highlight .nn { color: #555; } /* Name.Namespace */
+        .highlight .nt { color: #22863a; } /* Name.Tag */
+        .highlight .nv { color: #e36209; } /* Name.Variable */
+        .highlight .s { color: #032f62; } /* String */
+        .highlight .sb { color: #032f62; } /* String.Backtick */
+        .highlight .sc { color: #032f62; } /* String.Char */
+        .highlight .sd { color: #032f62; } /* String.Doc */
+        .highlight .s2 { color: #032f62; } /* String.Double */
+        .highlight .se { color: #032f62; } /* String.Escape */
+        .highlight .sh { color: #032f62; } /* String.Heredoc */
+        .highlight .si { color: #032f62; } /* String.Interpol */
+        .highlight .sx { color: #032f62; } /* String.Other */
+        .highlight .sr { color: #032f62; } /* String.Regex */
+        .highlight .s1 { color: #032f62; } /* String.Single */
+        .highlight .ss { color: #032f62; } /* String.Symbol */
+        .highlight .c { color: #6a737d; font-style: italic; } /* Comment */
+        .highlight .c1 { color: #6a737d; font-style: italic; } /* Comment.Single */
+        .highlight .cm { color: #6a737d; font-style: italic; } /* Comment.Multiline */
+        .highlight .cp { color: #6a737d; font-weight: 600; } /* Comment.Preproc */
+        .highlight .cs { color: #6a737d; font-weight: 600; font-style: italic; } /* Comment.Special */
+        .highlight .m { color: #005cc5; } /* Literal.Number */
+        .highlight .mb { color: #005cc5; } /* Literal.Number.Bin */
+        .highlight .mf { color: #005cc5; } /* Literal.Number.Float */
+        .highlight .mh { color: #005cc5; } /* Literal.Number.Hex */
+        .highlight .mi { color: #005cc5; } /* Literal.Number.Integer */
+        .highlight .il { color: #005cc5; } /* Literal.Number.Integer.Long */
+        .highlight .mo { color: #005cc5; } /* Literal.Number.Oct */
+        .highlight .o { color: #d73a49; } /* Operator */
+        .highlight .ow { color: #d73a49; } /* Operator.Word */
+        .highlight .p { color: #24292e; } /* Punctuation */
+        .highlight .w { color: #e1e4e8; } /* Text.Whitespace */
+        /* Skylighting classes */
+        .sourceCode .kw { color: #d73a49; font-weight: 600; } /* Keyword */
+        .sourceCode .dt { color: #6f42c1; } /* DataType */
+        .sourceCode .dv { color: #005cc5; } /* DecVal */
+        .sourceCode .bn { color: #005cc5; } /* BaseN */
+        .sourceCode .fl { color: #005cc5; } /* Float */
+        .sourceCode .ch { color: #032f62; } /* Char */
+        .sourceCode .st { color: #032f62; } /* String */
+        .sourceCode .co { color: #6a737d; font-style: italic; } /* Comment */
+        .sourceCode .ot { color: #22863a; } /* Other */
+        .sourceCode .al { color: #e36209; font-weight: 600; } /* Alert */
+        .sourceCode .fu { color: #6f42c1; font-weight: 600; } /* Function */
+        .sourceCode .re { color: #032f62; } /* RegionMarker */
+        .sourceCode .er { color: #d73a49; font-weight: 600; } /* Error */
+        .sourceCode .cf { color: #d73a49; font-weight: 600; } /* ControlFlow */
+        .sourceCode .op { color: #d73a49; } /* Operator */
+        .sourceCode .pp { color: #6a737d; } /* Preprocessor */
+        .sourceCode .at { color: #005cc5; } /* Attribute */
+        .sourceCode .do { color: #6a737d; font-style: italic; } /* Documentation */
+        .sourceCode .an { color: #6a737d; font-weight: 600; } /* Annotation */
+        .sourceCode .cv { color: #6a737d; font-weight: 600; font-style: italic; } /* CommentVar */
+        .sourceCode .in { color: #6a737d; } /* Information */
+        .sourceCode .wa { color: #e36209; font-weight: 600; } /* Warning */
+        .sourceCode .im { color: #d73a49; } /* Import */
+        .sourceCode .bu { color: #005cc5; } /* BuiltIn */
+        .sourceCode .ex { color: #6f42c1; } /* Extension */
+        .sourceCode .va { color: #e36209; } /* Variable */
+        .sourceCode .ss { color: #032f62; } /* SpecialString */
+        .sourceCode .sc { color: #032f62; } /* SpecialChar */
+        .sourceCode .vs { color: #032f62; } /* VerbatimString */
+        .sourceCode .il { color: #005cc5; } /* Special */
+        /* Line numbers (Skylighting) */
+        .sourceCode.numberSource .sourceCode { counter-reset: line; }
+        .sourceCode.numberSource .sourceCode > span { position: relative; left: -4em; counter-increment: line; }
+        .sourceCode.numberSource .sourceCode > span > a:first-child::before { content: counter(line); position: relative; left: -1em; text-align: right; vertical-align: baseline; border: none; display: inline-block; min-width: 1em; padding-right: 0.5em; color: #aaa; }
+      </style>
+      <style>
+        body {
+          font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif;
+          line-height: 1.6;
+          max-width: 800px;
+          margin: 2rem auto;
+          padding: 0 1rem;
+          color: #333;
+        }
+        pre { background: #f5f5f5; padding: 1rem; overflow-x: auto; }
+        code { background: #f0f0f0; padding: 0.2em 0.4em; border-radius: 3px; }
+        blockquote { border-left: 4px solid #ddd; margin: 0; padding-left: 1rem; color: #666; }
+        table { border-collapse: collapse; width: 100%%; }
+        th, td { border: 1px solid #ddd; padding: 0.5rem; }
+        th { background: #f5f5f5; }
+        tfoot td { background: #e8e8e8; }
+        figure.table-figure { width: fit-content; margin: 1em 0; }
+        figure.table-figure table { width: auto; }
+        figcaption { text-align: center; font-weight: bold; font-size: 0.8em; }
+        .page-break { page-break-after: always; }
+        .callout { padding: 1rem; margin: 1rem 0; border-left: 4px solid; }
+        .callout-note { border-color: #3b82f6; background: #eff6ff; }
+        .callout-warning { border-color: #f59e0b; background: #fffbeb; }
+        .callout-tip { border-color: #10b981; background: #f0fdf4; }
+        .callout-danger { border-color: #ef4444; background: #fef2f2; }
+        ins { background: #d4fcbc; text-decoration: none; }
+        del { background: #fbb6c2; text-decoration: line-through; }
+        mark { background: #fff3cd; }
+        .smallcaps { font-variant: small-caps; }
+        .underline { text-decoration: underline; }
+        span.mark { background: #fff3cd; }
+        .hidden { display: none; }
+        .quarto-xref { font-variant: normal; }
+        .critic.comment { background: #e7e7e7; color: #666; font-style: italic; }
+        .mkhashtag { color: #666; }
+        .mkstyledtag {
+          display: inline-block;
+          background: #e0e0e0;
+          padding: 3px 9px;
+          border-radius: 20px;
+          font-size: 0.9em;
+          line-height: 1.4;
+          color: #333;
+          margin: 0 2px;
+        }
+      </style>
+        <meta name="paginate" content="symbols"/>
+      <meta name="highlight-language-only" content="true"/>
+      <meta name="code-line-numbers" content="false"/>
+      <meta name="code-highlight" content="pygments"/>
+      <meta name="sup-sub" content="true"/>
+      <meta name="relaxed-tables" content="true"/>
+      <meta name="includes" content="true"/>
+      <meta name="autolink" content="true"/>
+      <meta name="pretty" content="false"/>
+      <meta name="standalone" content="false"/>
+      <meta name="mode" content="unified"/>
+      <meta name="markdown-in-html" content="true"/>
+      <meta name="image-captions" content="true"/>
+      <meta name="wikilink-extension" content="html"/>
+      <meta name="wikilink-space" content="hyphen"/>
+      <meta name="wikilinks" content="true"/>
+      <meta name="widont" content="true"/>
+      <meta name="plugins" content="true"/>
+      <meta name="id-format" content="gfm"/>
+  <style>
+:root {
+  /* border-box width of the fixed sidebar; body offset includes a small gap */
+  --sidebar-width: 250px;
+  --sidebar-offset: 270px;
+}
+/* Base styles — override Apex standalone centering (max-width + margin: auto) */
+body {
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+  font-size: 17px;
+  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
+    "Helvetica Neue", Arial, sans-serif;
+  line-height: 1.65;
+  color: #1e293b;
+  background-color: #fff;
+  max-width: none;
+  width: auto;
+  margin: 2rem 2rem 2rem var(--sidebar-offset);
+  padding: 0 1rem;
+  box-sizing: border-box;
+}
+/* Sidebar / Main TOC - wider on larger screens */
+.main-toc,
+.sidebar {
+  position: fixed;
+  left: 0;
+  top: 0;
+  box-sizing: border-box;
+  width: var(--sidebar-width);
+  min-width: var(--sidebar-width);
+  max-width: var(--sidebar-width);
+  height: 100vh;
+  overflow-y: auto;
+  background: #1e293b;
+  color: rgba(255, 255, 255, 0.9);
+  border-right: 2px solid rgba(255, 255, 255, 0.1);
+  padding: 24px 20px 130px;
+  font-size: 14px;
+  z-index: 100;
+  box-shadow: 4px 0 24px rgba(0, 0, 0, 0.08);
+  transition: transform 0.3s ease;
+}
+.main-toc ul,
+.sidebar ul {
+  list-style: none;
+  padding-left: 0;
+  margin: 0;
+  padding-bottom: 80px;
+}
+.main-toc ul::after,
+.sidebar ul::after {
+  content: "";
+  display: block;
+  height: 80px;
+}
+.main-toc li,
+.sidebar li {
+  margin: 0.25em 0;
+}
+.main-toc a,
+.sidebar a {
+  color: rgba(255, 255, 255, 0.85);
+  text-decoration: none;
+  display: block;
+  padding: 6px 12px;
+  border-radius: 4px;
+  transition: all 0.15s ease;
+  white-space: nowrap;
+  overflow: hidden;
+  text-overflow: ellipsis;
+}
+.main-toc a:hover,
+.sidebar a:hover {
+  background: #334155;
+  color: #fff;
+}
+.sidebar a.active {
+  color: #0ea5e9;
+  font-weight: 500;
+}
+/* Hamburger menu button */
+.hamburger-menu {
+  display: none;
+  position: fixed;
+  top: 12px;
+  left: 12px;
+  z-index: 200;
+  background: #1e293b;
+  border: 2px solid rgba(255, 255, 255, 0.1);
+  border-radius: 6px;
+  padding: 10px;
+  cursor: pointer;
+  color: rgba(255, 255, 255, 0.9);
+  font-size: 20px;
+  line-height: 1;
+  box-sizing: border-box;
+  width: 44px;
+  height: 44px;
+  align-items: center;
+  justify-content: center;
+  box-shadow: 0 2px 8px rgba(0, 0, 0, 0.2);
+  transition: all 0.2s ease;
+  opacity: 0.2;
+}
+.hamburger-menu:hover {
+  background: #334155;
+  color: #fff;
+  opacity: 1;
+}
+/* Move hamburger to the right of the sidebar when menu is open */
+.hamburger-menu.active {
+  left: calc(var(--sidebar-width) + 12px);
+}
+.hamburger-menu.active {
+  background: #0ea5e9;
+}
+.hamburger-menu::before {
+  content: "☰";
+}
+.hamburger-menu.active::before {
+  content: "✕";
+}
+/* Mobile menu overlay */
+.mobile-menu-overlay {
+  display: none;
+  position: fixed;
+  top: 0;
+  left: 0;
+  right: 0;
+  bottom: 0;
+  background: rgba(0, 0, 0, 0.5);
+  z-index: 150;
+  opacity: 0;
+  visibility: hidden;
+  transition: opacity 0.3s ease, visibility 0.3s ease;
+}
+.mobile-menu-overlay.active {
+  opacity: 1;
+  visibility: visible;
+}
+/* Page TOC */
+.page-toc {
+  background: #f9f9f9;
+  border: 1px solid #ddd;
+  border-radius: 4px;
+  padding: 1rem;
+  margin: 1.5rem 0;
+}
+.page-toc ul {
+  list-style: none;
+  padding-left: 0;
+  margin: 0;
+}
+.page-toc > ul {
+  padding-left: 0;
+}
+.page-toc li {
+  margin: 0.25em 0;
+}
+.page-toc a {
+  color: #0066cc;
+  text-decoration: none;
+  display: block;
+  padding: 0.25em 0.5em;
+  border-radius: 3px;
+}
+.page-toc a:hover {
+  background: #e0e0e0;
+  color: #004499;
+}
+.page-toc ul ul {
+  list-style: none;
+  padding-left: 1.5em;
+  margin-top: 0.25em;
+  margin-left: 0;
+}
+.page-toc ul ul ul {
+  padding-left: 1.5em;
+}
+.page-toc ul ul a {
+  font-size: 0.9em;
+  color: #555;
+}
+.page-toc ul ul ul a {
+  font-size: 0.85em;
+  color: #666;
+}
+/* Floating TOC */
+.floating-toc {
+  position: fixed;
+  top: 0;
+  left: var(--sidebar-offset);
+  right: 0;
+  z-index: 50;
+  opacity: 0;
+  visibility: hidden;
+  transition: opacity 0.2s ease, visibility 0.2s ease;
+  pointer-events: none;
+  display: flex;
+  justify-content: flex-end;
+  padding-right: 2rem;
+}
+.floating-toc.visible {
+  opacity: 1;
+  visibility: visible;
+  pointer-events: auto;
+}
+.floating-toc-container {
+  background: rgba(255, 255, 255, 0.95);
+  backdrop-filter: blur(10px);
+  border-bottom: 1px solid #ddd;
+  border-radius: 0 0 12px 12px;
+  box-shadow: 0 2px 8px rgba(0, 0, 0, 0.1);
+  width: fit-content;
+  max-width: 400px;
+  min-width: 200px;
+  overflow: hidden;
+  transition: max-height 0.3s ease;
+}
+.floating-toc-header {
+  padding: 8px 16px;
+  cursor: pointer;
+  user-select: none;
+  font-size: 14px;
+  font-weight: 500;
+  color: #1e293b;
+  display: flex;
+  align-items: center;
+  justify-content: space-between;
+}
+.floating-toc-header:hover {
+  background: rgba(0, 0, 0, 0.02);
+}
+.floating-toc-content {
+  max-height: 0;
+  overflow: hidden;
+  transition: max-height 0.3s ease;
+}
+.floating-toc-container:hover .floating-toc-content {
+  max-height: 70vh;
+  overflow-y: auto;
+}
+.floating-toc-content ul {
+  list-style: none;
+  padding: 8px 16px 16px;
+  margin: 0;
+}
+.floating-toc-content li {
+  margin: 0.1em 0;
+}
+.floating-toc-content a {
+  color: #0066cc;
+  text-decoration: none;
+  display: block;
+  padding: 0.2em 0.5em;
+  border-radius: 4px;
+  font-size: 13px;
+  transition: background 0.15s ease;
+}
+.floating-toc-content a:hover {
+  background: #e0e0e0;
+  color: #004499;
+}
+.floating-toc-content ul ul {
+  padding-left: 1.2em;
+  margin-top: 0;
+  margin-bottom: 0;
+}
+.floating-toc-content ul ul ul {
+  margin-top: 0;
+  margin-bottom: 0;
+}
+.floating-toc-content ul ul a {
+  font-size: 12px;
+  color: #555;
+}
+.floating-toc-content ul ul ul a {
+  font-size: 11px;
+  color: #666;
+}
+/* Smooth scrolling */
+html {
+  scroll-behavior: smooth;
+}
+/* Code blocks */
+code {
+  background: #f0f0f0;
+  padding: 0.2em 0.4em;
+  border-radius: 3px;
+  font-family: "Monaco", "Menlo", "Ubuntu Mono", monospace;
+  font-size: 0.9em;
+  margin: 0 0.1em;
+}
+pre {
+  background: #f5f5f5;
+  padding: 1rem;
+  overflow-x: auto;
+  border-radius: 4px;
+  margin: 1em 0;
+}
+pre code {
+  background: none;
+  padding: 0;
+  margin: 0;
+}
+/* Rouge syntax highlighting - GitHub theme, scoped to .highlight containers */
+.highlight {
+  color: #24292e;
+}
+.highlight .c {
+  color: #6a737d;
+  font-style: italic;
+} /* Comment */
+.highlight .err {
+  color: #a61717;
+  background-color: #e3d2d2;
+} /* Error */
+.highlight .k {
+  color: #d73a49;
+  font-weight: bold;
+} /* Keyword */
+.highlight .l {
+  color: #032f62;
+} /* Literal */
+.highlight .n {
+  color: #24292e;
+} /* Name */
+.highlight .o {
+  color: #d73a49;
+} /* Operator */
+.highlight .p {
+  color: #24292e;
+} /* Punctuation */
+.highlight .cm {
+  color: #6a737d;
+  font-style: italic;
+} /* Comment.Multiline */
+.highlight .cp {
+  color: #6a737d;
+  font-weight: bold;
+} /* Comment.Preproc */
+.highlight .c1 {
+  color: #6a737d;
+  font-style: italic;
+} /* Comment.Single */
+.highlight .cs {
+  color: #6a737d;
+  font-weight: bold;
+  font-style: italic;
+} /* Comment.Special */
+.highlight .gd {
+  color: #24292e;
+  background-color: #ffeef0;
+} /* Generic.Deleted */
+.highlight .ge {
+  color: #24292e;
+  font-style: italic;
+} /* Generic.Emph */
+.highlight .gr {
+  color: #aa0000;
+} /* Generic.Error */
+.highlight .gh {
+  color: #999999;
+  font-weight: bold;
+} /* Generic.Heading */
+.highlight .gi {
+  color: #24292e;
+  background-color: #f0fff4;
+} /* Generic.Inserted */
+.highlight .go {
+  color: #888888;
+} /* Generic.Output */
+.highlight .gp {
+  color: #555555;
+} /* Generic.Prompt */
+.highlight .gs {
+  font-weight: bold;
+} /* Generic.Strong */
+.highlight .gu {
+  color: #aaaaaa;
+} /* Generic.Subheading */
+.highlight .gt {
+  color: #aa0000;
+} /* Generic.Traceback */
+.highlight .kc {
+  color: #d73a49;
+  font-weight: bold;
+} /* Keyword.Constant */
+.highlight .kd {
+  color: #d73a49;
+  font-weight: bold;
+} /* Keyword.Declaration */
+.highlight .kn {
+  color: #d73a49;
+  font-weight: bold;
+} /* Keyword.Namespace */
+.highlight .kp {
+  color: #d73a49;
+  font-weight: bold;
+} /* Keyword.Pseudo */
+.highlight .kr {
+  color: #d73a49;
+  font-weight: bold;
+} /* Keyword.Reserved */
+.highlight .kt {
+  color: #d73a49;
+  font-weight: bold;
+} /* Keyword.Type */
+.highlight .ld {
+  color: #032f62;
+} /* Literal.Date */
+.highlight .m {
+  color: #005cc5;
+} /* Literal.Number */
+.highlight .s {
+  color: #032f62;
+} /* Literal.String */
+.highlight .na {
+  color: #6f42c1;
+} /* Name.Attribute */
+.highlight .nb {
+  color: #005cc5;
+} /* Name.Builtin */
+.highlight .nc {
+  color: #6f42c1;
+  font-weight: bold;
+} /* Name.Class */
+.highlight .no {
+  color: #005cc5;
+} /* Name.Constant */
+.highlight .nd {
+  color: #6f42c1;
+  font-weight: bold;
+} /* Name.Decorator */
+.highlight .ni {
+  color: #800080;
+} /* Name.Entity */
+.highlight .ne {
+  color: #990000;
+  font-weight: bold;
+} /* Name.Exception */
+.highlight .nf {
+  color: #6f42c1;
+} /* Name.Function */
+.highlight .nl {
+  color: #990000;
+} /* Name.Label */
+.highlight .nn {
+  color: #555555;
+} /* Name.Namespace */
+.highlight .nx {
+  color: #6f42c1;
+} /* Name.Other */
+.highlight .py {
+  color: #990000;
+} /* Name.Property */
+.highlight .nt {
+  color: #22863a;
+} /* Name.Tag */
+.highlight .nv {
+  color: #e36209;
+} /* Name.Variable */
+.highlight .ow {
+  color: #d73a49;
+  font-weight: bold;
+} /* Operator.Word */
+.highlight .w {
+  color: #bbbbbb;
+} /* Text.Whitespace */
+.highlight .mf {
+  color: #005cc5;
+} /* Literal.Number.Float */
+.highlight .mh {
+  color: #005cc5;
+} /* Literal.Number.Hex */
+.highlight .mi {
+  color: #005cc5;
+} /* Literal.Number.Integer */
+.highlight .mo {
+  color: #005cc5;
+} /* Literal.Number.Oct */
+.highlight .sb {
+  color: #032f62;
+} /* Literal.String.Backtick */
+.highlight .sc {
+  color: #032f62;
+} /* Literal.String.Char */
+.highlight .sd {
+  color: #032f62;
+} /* Literal.String.Doc */
+.highlight .s2 {
+  color: #032f62;
+} /* Literal.String.Double */
+.highlight .se {
+  color: #032f62;
+} /* Literal.String.Escape */
+.highlight .sh {
+  color: #032f62;
+} /* Literal.String.Heredoc */
+.highlight .si {
+  color: #032f62;
+} /* Literal.String.Interpol */
+.highlight .sx {
+  color: #032f62;
+} /* Literal.String.Other */
+.highlight .sr {
+  color: #22863a;
+} /* Literal.String.Regex */
+.highlight .s1 {
+  color: #032f62;
+} /* Literal.String.Single */
+.highlight .ss {
+  color: #032f62;
+} /* Literal.String.Symbol */
+.highlight .bp {
+  color: #005cc5;
+} /* Name.Builtin.Pseudo */
+.highlight .vc {
+  color: #e36209;
+} /* Name.Variable.Class */
+.highlight .vg {
+  color: #e36209;
+} /* Name.Variable.Global */
+.highlight .vi {
+  color: #e36209;
+} /* Name.Variable.Instance */
+.highlight .il {
+  color: #005cc5;
+} /* Literal.Number.Integer.Long */
+/* Additional Rouge token classes that may be used */
+.highlight .token {
+  color: #5670a0;
+}
+.highlight .token.list {
+  color: #546e9f;
+}
+.highlight .token.punctuation {
+  color: #3e8dad;
+}
+.highlight .token.list.punctuation {
+  color: #e05b78;
+}
+.highlight .token.content {
+  padding: 0;
+}
+/* Nested lists in page content */
+ul ul,
+ol ol,
+ul ol,
+ol ul {
+  padding-left: 1.5em;
+  margin-top: 0.25em;
+}
+/* Page footer */
+.page-footer {
+  background: #f5f5f5;
+  border-top: 1px solid #ddd;
+  padding: 1.5rem;
+  margin-top: 3rem;
+  color: #666;
+  font-size: 0.9em;
+}
+.page-footer p {
+  margin: 0.5em 0;
+}
+.page-footer a {
+  color: #0066cc;
+  text-decoration: none;
+}
+.page-footer a:hover {
+  text-decoration: underline;
+}
+/* Mobile responsive */
+@media (max-width: 768px) {
+  .hamburger-menu {
+    display: flex;
+  }
+  .main-toc,
+  .sidebar {
+    transform: translateX(-100%);
+    z-index: 175;
+  }
+  .main-toc.mobile-open,
+  .sidebar.mobile-open {
+    transform: translateX(0);
+  }
+  body {
+    margin: 2rem 1rem;
+  }
+  .floating-toc {
+    left: 0;
+  }
+}
+</style></head>
+  <body class="code-highlighted">
+<div class="floating-toc" id="floating-toc">
+  <div class="floating-toc-container">
+    <div class="floating-toc-header">
+      <span>Table of Contents 🔻</span>
+    </div>
+    <div class="floating-toc-content" id="floating-toc-content">
+      <!-- Content will be populated by JavaScript -->
+    </div>
+  </div>
+</div>
+<button class="hamburger-menu" id="hamburger-menu" aria-label="Toggle navigation"></button>
+<div class="mobile-menu-overlay" id="mobile-menu-overlay"></div>
+<nav class="main-toc"><ul><li><a href="Home.html">Home</a></li><li><a href="Getting-Started.html">Getting Started</a></li><li><a href="Installation.html">Installation</a></li><li><a href="Usage.html">Usage</a></li><li><a href="Syntax.html">Syntax</a></li><li><a href="Callouts.html">Callouts</a></li><li><a href="Tables.html">Tables</a></li><li><a href="Inline-Attribute-Lists.html">Inline Attribute Lists</a></li><li><a href="Modes.html">Modes</a></li><li><a href="Quarto-Mode.html">Quarto Mode</a></li><li><a href="Command-Line-Options.html">Command Line Options</a></li><li><a href="Rendering-Markdown-In-Terminal.html">Rendering Markdown in the Terminal</a></li><li><a href="Generating-Man-Pages.html">Generating Man Pages</a></li><li><a href="Multi-File-Documents.html">Multi-file Documents</a></li><li><a href="Citations.html">Citations</a></li><li><a href="Indices.html">Indices</a></li><li><a href="Metadata-Transforms.html">Metadata Transforms</a></li><li><a href="Pandoc-Integration.html">Integrating with Pandoc</a></li><li><a href="Using-Apex-with-Jekyll.html">Using Apex with Jekyll</a></li><li><a href="Header-IDs.html">Header IDs</a></li><li><a href="C-API.html">C API</a></li><li><a href="Writing-Tests.html">Writing Tests</a></li><li><a href="Xcode-Integration.html">Xcode Integration</a></li><li><a href="Examples.html">Examples</a></li><li><a href="Plugins.html">Plugins</a></li><li><a href="Filters.html">Filters</a></li><li><a href="Troubleshooting.html">Troubleshooting</a></li><li><a href="Credits.html">Credits</a></li></ul></nav>
+    <h1 id="indices">
+      Indices
+    </h1>
+<nav class="page-toc" id="page-toc-top"><ul><li><a href="#indices">Indices</a><ul><li><a href="#overview">Overview</a></li><li><a href="#syntax">Syntax</a><ul><li><a href="#mmark-index-syntax">mmark Index&nbsp;Syntax</a></li><li><a href="#textindex-syntax">TextIndex&nbsp;Syntax</a></li><li><a href="#leanpub-index-syntax">Leanpub Index&nbsp;Syntax</a></li></ul></li><li><a href="#index-generation">Index&nbsp;Generation</a><ul><li><a href="#automatic-placement">Automatic&nbsp;Placement</a></li><li><a href="#custom-placement">Custom&nbsp;Placement</a></li></ul></li><li><a href="#command-line-options">Command-Line&nbsp;Options</a><ul><li><a href="#indices">--indices</a></li><li><a href="#no-indices">--no-indices</a></li><li><a href="#no-index">--no-index</a></li></ul></li><li><a href="#configuration">Configuration</a><ul><li><a href="#metadata-options">Metadata&nbsp;Options</a></li><li><a href="#configuration-file">Configuration&nbsp;File</a></li></ul></li><li><a href="#examples">Examples</a><ul><li><a href="#basic-index-example">Basic Index&nbsp;Example</a></li><li><a href="#textindex-example">TextIndex&nbsp;Example</a></li><li><a href="#index-with-custom-placement">Index with Custom&nbsp;Placement</a></li><li><a href="#primary-entries-example">Primary Entries&nbsp;Example</a></li></ul></li><li><a href="#output-format">Output&nbsp;Format</a></li><li><a href="#tips-and-best-practices">Tips and Best&nbsp;Practices</a></li><li><a href="#related">Related</a></li></ul></li><li><a href="#index-section">Index</a></li></ul></nav>
+    <p>
+      Apex supports automatic index generation from index markers in your Markdown documents. Indices enable you to mark terms and concepts in your text and automatically generate a comprehensive index at the end of your document.
+    </p>
+    <h2 id="overview">
+      Overview
+    </h2>
+    <p>
+      <strong>Supported modes:</strong> MultiMarkdown and unified (enabled by default)
+    </p>
+    <p>
+      <strong>Default behavior:</strong> Indices are automatically enabled in MultiMarkdown and unified modes. In other modes, use the <code>--indices</code> flag to enable them.
+    </p>
+    <p>
+      <strong>Index features:</strong>
+    </p>
+    <ul>
+      <li>
+        Three syntaxes supported: mmark, TextIndex, and Leanpub
+      </li>
+      <li>
+        Automatic alphabetical sorting
+      </li>
+      <li>
+        Optional grouping by first letter
+      </li>
+      <li>
+        Hierarchical sub-items
+      </li>
+      <li>
+        Primary entries (bold entries in the index)
+      </li>
+      <li>
+        Automatic index generation at document end or custom marker
+      </li>
+    </ul>
+    <h2 id="syntax">
+      Syntax
+    </h2>
+    <p>
+      Apex supports two index syntax formats:
+    </p>
+    <h3 id="mmark-index-syntax">
+      mmark Index&nbsp;Syntax
+    </h3>
+    <p>
+      The mmark syntax uses parentheses with exclamation marks to create index entries.
+    </p>
+    <p>
+      <strong>Basic index entry:</strong>
+    </p>
+    <div class="highlight">
+<pre><span></span>This is about protocols &lt;!--IDX:idxref-0--&gt;.
+    </pre>
+  </div>
+  <p>
+    <strong>Sub-item entry:</strong>
+  </p>
+  <div class="highlight">
+<pre><span></span>HTTP/1.1 &lt;!--IDX:idxref-1--&gt; is a protocol version.
+  </pre>
+</div>
+<p>
+  The first term is the main entry, and the second term (after the comma) is the sub-item. Sub-items appear nested under their main entries in the generated index.
+</p>
+<p>
+  <strong>Primary entry (bold in index):</strong>
+</p>
+<div class="highlight">
+<pre><span></span>This is a primary topic &lt;!--IDX:idxref-2--&gt;.
+</pre>
+</div>
+<p>
+  Using <code>!!</code> instead of <code>!</code> marks the entry as a primary entry. Primary entries are typically rendered in bold in the generated index.
+</p>
+<p>
+  <strong>Multiple entries:</strong>
+</p>
+<div class="highlight">
+<pre><span></span>Protocols &lt;!--IDX:idxref-3--&gt; and implementations &lt;!--IDX:idxref-4--&gt; are important.
+</pre>
+</div>
+<p>
+  You can have multiple index entries in the same paragraph or sentence.
+</p>
+<p>
+  <strong>Examples:</strong>
+</p>
+<div class="highlight">
+<pre><span></span>The Hypertext Transfer Protocol &lt;!--IDX:idxref-5--&gt; is widely used.
+There are multiple versions &lt;!--IDX:idxref-6--&gt; and &lt;!--IDX:idxref-7--&gt;.
+Security protocols &lt;!--IDX:idxref-8--&gt; like TLS &lt;!--IDX:idxref-9--&gt; are essential.
+</pre>
+</div>
+<h3 id="textindex-syntax">
+  TextIndex&nbsp;Syntax
+</h3>
+<p>
+  TextIndex syntax uses curly braces with a caret (<code>{^}</code>) to mark index entries.
+</p>
+<p>
+  <strong>Basic syntax (indexes preceding word):</strong>
+</p>
+<div class="highlight">
+<pre><span></span>Most mechanical keyboard firmware&lt;!--IDX:idxref-10--&gt; supports key combinations.
+</pre>
+</div>
+<p>
+  The <code>{^}</code> marks the word immediately before it for indexing. In this case, “firmware” will be indexed.
+</p>
+<p>
+  <strong>Explicit term:</strong>
+</p>
+<div class="highlight">
+<pre><span></span>This uses [key combinations]&lt;!--IDX:idxref-11--&gt; for indexing.
+</pre>
+</div>
+<p>
+  Square brackets allow you to specify the exact term to index, which may differ from the visible text.
+</p>
+<p>
+  <strong>With parameters:</strong>
+</p>
+<div class="highlight">
+<pre><span></span>Term&lt;!--IDX:idxref-12--&gt;
+</pre>
+</div>
+<p>
+  Parameters can be included after the caret, though they are typically handled by the index generation system.
+</p>
+<p>
+  <strong>Examples:</strong>
+</p>
+<div class="highlight">
+<pre><span></span>Python&lt;!--IDX:idxref-13--&gt; is a programming language.
+We use [machine learning]&lt;!--IDX:idxref-14--&gt; techniques.
+The API&lt;!--IDX:idxref-15--&gt; provides access.
+</pre>
+</div>
+<h3 id="leanpub-index-syntax">
+  Leanpub Index&nbsp;Syntax
+</h3>
+<p>
+  Leanpub (Markua) index syntax uses <code>&lt;!--IDX:idxref-16--&gt;</code> to mark index entries. See the <a href="https://help.leanpub.com/en/articles/6961502-how-to-create-an-index-in-a-leanpub-book">Leanpub index documentation</a> for full details.
+</p>
+<p>
+  <strong>Basic index entry:</strong>
+</p>
+<div class="highlight">
+<pre><span></span>Call me Ishmael&lt;!--IDX:idxref-17--&gt;
+</pre>
+</div>
+<p>
+  <strong>Entries under headings (hierarchical):</strong>
+</p>
+<div class="highlight">
+<pre><span></span>Were Niagara&lt;!--IDX:idxref-18--&gt; but a cataract of sand&lt;!--IDX:idxref-19--&gt;.
+</pre>
+</div>
+<p>
+  The <code>Main!sub</code> format places the sub-item under the main heading in the generated index. Formatting like <code>*italics*</code> and <code>**bold**</code> within the entry is stripped for the index display.
+</p>
+<p>
+  <strong>Sort form (for “Lastname, Firstname” or “something, the”):</strong>
+</p>
+<div class="highlight">
+<pre><span></span>Circumambulate the city of a dreamy Sabbath&lt;!--IDX:idxref-20--&gt; afternoon.
+</pre>
+</div>
+<p>
+  <strong>Examples:</strong>
+</p>
+<div class="highlight">
+<pre><span></span>Call me Ishmael&lt;!--IDX:idxref-21--&gt;
+Niagara&lt;!--IDX:idxref-22--&gt; is a waterfall.
+Sabbath&lt;!--IDX:idxref-23--&gt; afternoon.
+</pre>
+</div>
+<h2 id="index-generation">
+  Index&nbsp;Generation
+</h2>
+<p>
+  The index is automatically generated and placed in your document based on the following rules:
+</p>
+<h3 id="automatic-placement">
+  Automatic&nbsp;Placement
+</h3>
+<p>
+  By default, the index is generated at the <strong>end of the document</strong> after all content.
+</p>
+<h3 id="custom-placement">
+  Custom&nbsp;Placement
+</h3>
+<p>
+  You can control where the index appears using the <code>&lt;!--INDEX--&gt;</code> marker or Leanpub’s <code>{index}</code> marker:
+</p>
+<div class="highlight">
+<pre><span></span><span class="gh"># Document</span>
+This is about protocols &lt;!--IDX:idxref-24--&gt;.
+&lt;!--INDEX--&gt;
+More content after the index.
+</pre>
+</div>
+<p>
+  When the <code>&lt;!--INDEX--&gt;</code> marker is present, the index is inserted at that location instead of the end of the document.
+</p>
+<p>
+  <strong>Leanpub compatibility:</strong> Apex also accepts <code>{index}</code> as a placement marker (as used in Leanpub/Markua). The literal <code>{index}</code> is replaced with <code>&lt;!--INDEX--&gt;</code> during preprocessing, so it is always removed from the output—either replaced by the generated index or left as an invisible HTML comment when the index is suppressed. This matches Leanpub’s behavior where the index is placed at the marker (Leanpub moves it to the very end of the book regardless; in Apex the index appears at the marker position).
+</p>
+<h2 id="command-line-options">
+  Command-Line&nbsp;Options
+</h2>
+<h3 id="indices">
+<code>--indices</code>
+</h3>
+<p>
+  Enable index processing with both mmark and TextIndex syntax support.
+</p>
+<p>
+  <strong>Default:</strong> Enabled in MultiMarkdown and unified modes
+</p>
+<p>
+  <strong>Behavior:</strong>
+</p>
+<ul>
+  <li>
+    Enables mmark syntax (<code>&lt;!--IDX:idxref-25--&gt;</code>, <code>&lt;!--IDX:idxref-26--&gt;</code>, <code>&lt;!--IDX:idxref-27--&gt;</code>), TextIndex syntax (<code>{^}</code>, <code>[term]&lt;!--IDX:idxref-28--&gt;</code>), and Leanpub syntax (<code>&lt;!--IDX:idxref-29--&gt;</code>, <code>&lt;!--IDX:idxref-30--&gt;</code>)
+  </li>
+  <li>
+    Index entries are collected during parsing
+  </li>
+  <li>
+    Index is automatically generated at the end of the document or at <code>&lt;!--INDEX--&gt;</code> marker
+  </li>
+  <li>
+    Entries are sorted alphabetically and can be grouped by first letter
+  </li>
+</ul>
+<p>
+  <strong>Example:</strong>
+</p>
+<div class="highlight">
+<pre><span></span>apex<span class="w"> </span>document.md<span class="w"> </span>--indices
+</pre>
+</div>
+<p>
+  <strong>When to use:</strong>
+</p>
+<ul>
+  <li>
+    Enable indices in modes where they’re disabled by default (commonmark, gfm, kramdown)
+  </li>
+  <li>
+    Explicitly enable indices when using unified or MultiMarkdown modes (optional, since enabled by default)
+  </li>
+</ul>
+<h3 id="no-indices">
+<code>--no-indices</code>
+</h3>
+<p>
+  Disable index processing entirely.
+</p>
+<p>
+  <strong>Example:</strong>
+</p>
+<div class="highlight">
+<pre><span></span>apex<span class="w"> </span>document.md<span class="w"> </span>--no-indices
+</pre>
+</div>
+<p>
+  <strong>Behavior:</strong>
+</p>
+<ul>
+  <li>
+    Index syntax is treated as plain text
+  </li>
+  <li>
+    No index markers are created in the document
+  </li>
+  <li>
+    No index section is generated
+  </li>
+  <li>
+    Useful when you want to preserve index syntax in the source but not process it
+  </li>
+</ul>
+<p>
+  <strong>Note:</strong> When disabled, index syntax like <code>&lt;!--IDX:idxref-31--&gt;</code> and <code>{^}</code> will appear literally in your output.
+</p>
+<h3 id="no-index">
+<code>--no-index</code>
+</h3>
+<p>
+  Suppress index generation while still creating index markers in the document.
+</p>
+<p>
+  <strong>Example:</strong>
+</p>
+<div class="highlight">
+<pre><span></span>apex<span class="w"> </span>document.md<span class="w"> </span>--no-index
+</pre>
+</div>
+<p>
+  <strong>Behavior:</strong>
+</p>
+<ul>
+  <li>
+    Index markers (<code>&lt;span class=&quot;index&quot; id=&quot;idxref:N&quot;&gt;</code>) are still created in the document
+  </li>
+  <li>
+    Index section is <strong>not</strong> generated at the end
+  </li>
+  <li>
+    Useful when you want to mark terms but generate the index separately or later
+  </li>
+</ul>
+<p>
+  <strong>Use cases:</strong>
+</p>
+<ul>
+  <li>
+    Marking terms for future index generation
+  </li>
+  <li>
+    Generating index separately with different options
+  </li>
+  <li>
+    Using external tools to build the index from the markers
+  </li>
+</ul>
+<h2 id="configuration">
+  Configuration
+</h2>
+<h3 id="metadata-options">
+  Metadata&nbsp;Options
+</h3>
+<p>
+  Index behavior can be controlled via document metadata or a configuration file.
+</p>
+<p>
+  <strong>Enable/disable indices:</strong>
+</p>
+<div class="highlight">
+<pre><span></span><span class="nn">---</span>
+<span class="nt">indices</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w">  </span><span class="c1"># or false</span>
+<span class="nn">---</span>
+</pre>
+</div>
+<p>
+  <strong>Suppress index generation:</strong>
+</p>
+<div class="highlight">
+<pre><span></span><span class="nn">---</span>
+<span class="nt">suppress-index</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w">  </span><span class="c1"># Generate markers but not the index section</span>
+<span class="nn">---</span>
+</pre>
+</div>
+<p>
+  <strong>Group by letter:</strong>
+</p>
+<div class="highlight">
+<pre><span></span><span class="nn">---</span>
+<span class="nt">group-index-by-letter</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w">  </span><span class="c1"># Group entries alphabetically by first letter</span>
+<span class="nn">---</span>
+</pre>
+</div>
+<p>
+  When <code>group-index-by-letter</code> is enabled, the index groups entries under letter headings (A, B, C, etc.), making it easier to navigate longer indices.
+</p>
+<p>
+  <strong>Complete example:</strong>
+</p>
+<div class="highlight">
+<pre><span></span><span class="nn">---</span>
+<span class="nt">indices</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
+<span class="nt">group-index-by-letter</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
+<span class="nn">---</span>
+</pre>
+</div>
+<h3 id="configuration-file">
+  Configuration&nbsp;File
+</h3>
+<p>
+  You can also set these options in your global <code>config.yml</code> file:
+</p>
+<div class="highlight">
+<pre><span></span><span class="nn">---</span>
+<span class="nt">indices</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
+<span class="nt">group-index-by-letter</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
+<span class="nn">---</span>
+</pre>
+</div>
+<p>
+  This applies the settings to all documents unless overridden by document metadata or command-line flags.
+</p>
+<h2 id="examples">
+  Examples
+</h2>
+<h3 id="basic-index-example">
+  Basic Index&nbsp;Example
+</h3>
+<p>
+  <strong>Input:</strong>
+</p>
+<div class="highlight">
+<pre><span></span><span class="gh"># Network Protocols</span>
+The Hypertext Transfer Protocol &lt;!--IDX:idxref-32--&gt; is the foundation of the web.
+There are several versions including &lt;!--IDX:idxref-33--&gt; and &lt;!--IDX:idxref-34--&gt;.
+Secure communication uses &lt;!--IDX:idxref-35--&gt; for encryption.
+</pre>
+</div>
+<p>
+  <strong>Output with <code>--indices</code>:</strong>
+</p>
+<div class="highlight">
+<pre><span></span><span class="p">&lt;</span><span class="nt">h1</span><span class="p">&gt;</span>Network Protocols<span class="p">&lt;/</span><span class="nt">h1</span><span class="p">&gt;</span>
+<span class="p">&lt;</span><span class="nt">p</span><span class="p">&gt;</span>The Hypertext Transfer Protocol <span class="p">&lt;</span><span class="nt">span</span> <span class="na">class</span><span class="o">=</span><span class="s">&quot;index&quot;</span> <span class="na">id</span><span class="o">=</span><span class="s">&quot;idxref:0&quot;</span><span class="p">&gt;&lt;/</span><span class="nt">span</span><span class="p">&gt;</span> is the foundation of the web.<span class="p">&lt;/</span><span class="nt">p</span><span class="p">&gt;</span>
+<span class="p">&lt;</span><span class="nt">p</span><span class="p">&gt;</span>There are several versions including <span class="p">&lt;</span><span class="nt">span</span> <span class="na">class</span><span class="o">=</span><span class="s">&quot;index&quot;</span> <span class="na">id</span><span class="o">=</span><span class="s">&quot;idxref:1&quot;</span><span class="p">&gt;&lt;/</span><span class="nt">span</span><span class="p">&gt;</span> and <span class="p">&lt;</span><span class="nt">span</span> <span class="na">class</span><span class="o">=</span><span class="s">&quot;index&quot;</span> <span class="na">id</span><span class="o">=</span><span class="s">&quot;idxref:2&quot;</span><span class="p">&gt;&lt;/</span><span class="nt">span</span><span class="p">&gt;</span>.<span class="p">&lt;/</span><span class="nt">p</span><span class="p">&gt;</span>
+<span class="p">&lt;</span><span class="nt">p</span><span class="p">&gt;</span>Secure communication uses <span class="p">&lt;</span><span class="nt">span</span> <span class="na">class</span><span class="o">=</span><span class="s">&quot;index&quot;</span> <span class="na">id</span><span class="o">=</span><span class="s">&quot;idxref:3&quot;</span><span class="p">&gt;&lt;/</span><span class="nt">span</span><span class="p">&gt;</span> for encryption.<span class="p">&lt;/</span><span class="nt">p</span><span class="p">&gt;</span>
+<span class="p">&lt;</span><span class="nt">h1</span> <span class="na">id</span><span class="o">=</span><span class="s">&quot;index-section&quot;</span><span class="p">&gt;</span>Index<span class="p">&lt;/</span><span class="nt">h1</span><span class="p">&gt;</span>
+<span class="p">&lt;</span><span class="nt">div</span> <span class="na">class</span><span class="o">=</span><span class="s">&quot;index&quot;</span><span class="p">&gt;</span>
+<span class="p">&lt;</span><span class="nt">ul</span><span class="p">&gt;</span>
+<span class="p">&lt;</span><span class="nt">li</span><span class="p">&gt;</span>HTTP
+  <span class="p">&lt;</span><span class="nt">ul</span><span class="p">&gt;</span>
+  <span class="p">&lt;</span><span class="nt">li</span><span class="p">&gt;</span>HTTP/1.0<span class="p">&lt;/</span><span class="nt">li</span><span class="p">&gt;</span>
+  <span class="p">&lt;</span><span class="nt">li</span><span class="p">&gt;</span>HTTP/1.1<span class="p">&lt;/</span><span class="nt">li</span><span class="p">&gt;</span>
+  <span class="p">&lt;/</span><span class="nt">ul</span><span class="p">&gt;</span>
+<span class="p">&lt;/</span><span class="nt">li</span><span class="p">&gt;</span>
+<span class="p">&lt;</span><span class="nt">li</span><span class="p">&gt;</span>TLS<span class="p">&lt;/</span><span class="nt">li</span><span class="p">&gt;</span>
+<span class="p">&lt;/</span><span class="nt">ul</span><span class="p">&gt;</span>
+<span class="p">&lt;/</span><span class="nt">div</span><span class="p">&gt;</span>
+</pre>
+</div>
+<h3 id="textindex-example">
+  TextIndex&nbsp;Example
+</h3>
+<p>
+  <strong>Input:</strong>
+</p>
+<div class="highlight">
+<pre><span></span>Python&lt;!--IDX:idxref-36--&gt; is a versatile language.
+We use [machine learning]&lt;!--IDX:idxref-37--&gt; for data analysis.
+The API&lt;!--IDX:idxref-38--&gt; allows programmatic access.
+</pre>
+</div>
+<p>
+  <strong>Output:</strong>
+  The index will include entries for “Python”, “machine learning” (or “ML” if using parameters), and “API” (or “Application Programming Interface” based on the syntax used).
+</p>
+<h3 id="index-with-custom-placement">
+  Index with Custom&nbsp;Placement
+</h3>
+<p>
+  <strong>Input:</strong>
+</p>
+<div class="highlight">
+<pre><span></span><span class="gh"># Introduction</span>
+This document covers networking &lt;!--IDX:idxref-39--&gt;.
+<span class="gh"># Main Content</span>
+More content about protocols &lt;!--IDX:idxref-40--&gt;.
+&lt;!--INDEX--&gt;
+<span class="gh"># Appendix</span>
+Additional information goes here.
+</pre>
+</div>
+<p>
+  <strong>Output:</strong>
+  The index appears between the main content and the appendix section, not at the very end of the document.
+</p>
+<h3 id="primary-entries-example">
+  Primary Entries&nbsp;Example
+</h3>
+<p>
+  <strong>Input:</strong>
+</p>
+<div class="highlight">
+<pre><span></span>The main topic is &lt;!--IDX:idxref-41--&gt;.
+Subtopics include &lt;!--IDX:idxref-42--&gt; and &lt;!--IDX:idxref-43--&gt;.
+</pre>
+</div>
+<p>
+  <strong>Output:</strong>
+  The index entry “Networking” will be marked as primary (typically bold), with “TCP” and “UDP” as sub-items.
+</p>
+<h2 id="output-format">
+  Output&nbsp;Format
+</h2>
+<p>
+  Index entries in the document are marked with <code>&lt;span class=&quot;index&quot; id=&quot;idxref:N&quot;&gt;</code> elements. These markers:
+</p>
+<ul>
+  <li>
+    Are invisible in the rendered output
+  </li>
+  <li>
+    Link back from the index entries to their locations in the text
+  </li>
+  <li>
+    Use sequential IDs (<code>idxref:0</code>, <code>idxref:1</code>, etc.)
+  </li>
+</ul>
+<p>
+  The generated index section includes:
+</p>
+<ul>
+  <li>
+    A heading (<code>&lt;h1 id=&quot;index-section&quot;&gt;Index&lt;/h1&gt;</code>)
+  </li>
+  <li>
+    A <code>&lt;div class=&quot;index&quot;&gt;</code> container
+  </li>
+  <li>
+    A nested <code>&lt;ul&gt;</code> structure for main entries and sub-items
+  </li>
+  <li>
+    Links from each index entry back to its location in the document
+  </li>
+</ul>
+<p>
+  When <code>group-index-by-letter</code> is enabled, entries are organized under letter headings for easier navigation.
+</p>
+<h2 id="tips-and-best-practices">
+  Tips and Best&nbsp;Practices
+</h2>
+<ol>
+  <li>
+    <p>
+      <strong>Consistency</strong>: Use the same term consistently for similar concepts (e.g., always use <code>&lt;!--IDX:idxref-44--&gt;</code> rather than mixing <code>&lt;!--IDX:idxref-45--&gt;</code> and <code>&lt;!--IDX:idxref-46--&gt;</code>).
+    </p>
+  </li>
+  <li>
+    <p>
+      <strong>Hierarchy</strong>: Use sub-items to create logical hierarchies (e.g., <code>&lt;!--IDX:idxref-47--&gt;</code> groups HTTP under Protocol).
+    </p>
+  </li>
+  <li>
+    <p>
+      <strong>Primary entries</strong>: Use <code>!!</code> for main topics or key concepts that should stand out in the index.
+    </p>
+  </li>
+  <li>
+    <p>
+      <strong>Placement</strong>: Use <code>&lt;!--INDEX--&gt;</code> to place the index where it makes sense for your document structure (e.g., before appendices but after main content).
+    </p>
+  </li>
+  <li>
+    <p>
+      <strong>Testing</strong>: Use <code>--no-index</code> when developing to see where markers are placed without generating the full index each time.
+    </p>
+  </li>
+</ol>
+<h2 id="related">
+  Related
+</h2>
+<ul>
+  <li>
+    <a href="Command-Line-Options#indices">Command Line Options</a> - Complete CLI reference for index options
+  </li>
+  <li>
+    <a href="Syntax#indices">Syntax</a> - Index syntax reference
+  </li>
+  <li>
+    <a href="Configuration.html">Configuration</a> - Metadata configuration options
+  </li>
+  <li>
+    <a href="Modes.html">Modes</a> - Mode-specific index availability
+  </li>
+</ul>
+<h1 id="index-section">
+  Index
+</h1>
+<div class="index">
+  <dl>
+    <dt>
+      H
+    </dt>
+    <dd>
+      <ul>
+        <li>
+          HTTP <a class="index-return" href="#idxref-5"><sup>[go]</sup></a>
+        </li>
+        <li>
+          HTTP <a class="index-return" href="#idxref-32"><sup>[go]</sup></a>
+        </li>
+        <li>
+          HTTP <a class="index-return" href="#idxref-45"><sup>[go]</sup></a>
+        </li>
+        <li>
+          HTTP <a class="index-return" href="#idxref-44"><sup>[go]</sup></a>
+        </li>
+        <li>
+          HTTP <a class="index-return" href="#idxref-33"><sup>[go]</sup></a>
+          <ul>
+            <li>
+              HTTP/1.0 <a class="index-return" href="#idxref-33"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+        <li>
+          HTTP <a class="index-return" href="#idxref-6"><sup>[go]</sup></a>
+          <ul>
+            <li>
+              HTTP/1.0 <a class="index-return" href="#idxref-6"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+        <li>
+          HTTP <a class="index-return" href="#idxref-1"><sup>[go]</sup></a>
+          <ul>
+            <li>
+              HTTP/1.1 <a class="index-return" href="#idxref-1"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+        <li>
+          HTTP <a class="index-return" href="#idxref-7"><sup>[go]</sup></a>
+          <ul>
+            <li>
+              HTTP/1.1 <a class="index-return" href="#idxref-7"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+        <li>
+          HTTP <a class="index-return" href="#idxref-34"><sup>[go]</sup></a>
+          <ul>
+            <li>
+              HTTP/1.1 <a class="index-return" href="#idxref-34"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+        <li>
+          Hypertext Transfer Protocol <a class="index-return" href="#idxref-46"><sup>[go]</sup></a>
+        </li>
+      </ul>
+    </dd>
+  </dl>
+  <dl>
+    <dt>
+      I
+    </dt>
+    <dd>
+      <ul>
+        <li>
+          Implementation <a class="index-return" href="#idxref-4"><sup>[go]</sup></a>
+        </li>
+        <li>
+          Ishmael <a class="index-return" href="#idxref-17"><sup>[go]</sup></a>
+        </li>
+        <li>
+          Ishmael <a class="index-return" href="#idxref-21"><sup>[go]</sup></a>
+        </li>
+        <li>
+          item <a class="index-return" href="#idxref-31"><sup>[go]</sup></a>
+        </li>
+        <li>
+          item <a class="index-return" href="#idxref-25"><sup>[go]</sup></a>
+        </li>
+        <li>
+          item <a class="index-return" href="#idxref-26"><sup>[go]</sup></a>
+          <ul>
+            <li>
+              subitem <a class="index-return" href="#idxref-26"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+        <li>
+          item <strong> <a class="index-return" href="#idxref-27"><sup>[go]</sup></a></strong>
+          <ul>
+            <li>
+              subitem <a class="index-return" href="#idxref-27"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+      </ul>
+    </dd>
+  </dl>
+  <dl>
+    <dt>
+      K
+    </dt>
+    <dd>
+      <ul>
+        <li>
+          key combinations <a class="index-return" href="#idxref-11"><sup>[go]</sup></a>
+        </li>
+      </ul>
+    </dd>
+  </dl>
+  <dl>
+    <dt>
+      M
+    </dt>
+    <dd>
+      <ul>
+        <li>
+          machine learning <a class="index-return" href="#idxref-14"><sup>[go]</sup></a>
+        </li>
+        <li>
+          machine learning <a class="index-return" href="#idxref-37"><sup>[go]</sup></a>
+        </li>
+        <li>
+          Main <a class="index-return" href="#idxref-30"><sup>[go]</sup></a>
+          <ul>
+            <li>
+              sub <a class="index-return" href="#idxref-30"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+        <li>
+          Most mechanical keyboard firmware <a class="index-return" href="#idxref-10"><sup>[go]</sup></a>
+        </li>
+      </ul>
+    </dd>
+  </dl>
+  <dl>
+    <dt>
+      N
+    </dt>
+    <dd>
+      <ul>
+        <li>
+          Networking <a class="index-return" href="#idxref-39"><sup>[go]</sup></a>
+        </li>
+        <li>
+          Networking <strong> <a class="index-return" href="#idxref-41"><sup>[go]</sup></a></strong>
+        </li>
+        <li>
+          Networking <a class="index-return" href="#idxref-42"><sup>[go]</sup></a>
+          <ul>
+            <li>
+              TCP <a class="index-return" href="#idxref-42"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+        <li>
+          Networking <a class="index-return" href="#idxref-43"><sup>[go]</sup></a>
+          <ul>
+            <li>
+              UDP <a class="index-return" href="#idxref-43"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+        <li>
+          Niagara <a class="index-return" href="#idxref-18"><sup>[go]</sup></a>
+          <ul>
+            <li>
+              cataract <a class="index-return" href="#idxref-18"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+        <li>
+          Niagara <a class="index-return" href="#idxref-22"><sup>[go]</sup></a>
+          <ul>
+            <li>
+              cataract <a class="index-return" href="#idxref-22"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+        <li>
+          Niagara <a class="index-return" href="#idxref-19"><sup>[go]</sup></a>
+          <ul>
+            <li>
+              sand <a class="index-return" href="#idxref-19"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+      </ul>
+    </dd>
+  </dl>
+  <dl>
+    <dt>
+      P
+    </dt>
+    <dd>
+      <ul>
+        <li>
+          Primary Topic <strong> <a class="index-return" href="#idxref-2"><sup>[go]</sup></a></strong>
+          <ul>
+            <li>
+              Sub Topic <a class="index-return" href="#idxref-2"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+        <li>
+          Protocol <a class="index-return" href="#idxref-40"><sup>[go]</sup></a>
+        </li>
+        <li>
+          Protocol <a class="index-return" href="#idxref-24"><sup>[go]</sup></a>
+        </li>
+        <li>
+          Protocol <a class="index-return" href="#idxref-0"><sup>[go]</sup></a>
+        </li>
+        <li>
+          Protocol <a class="index-return" href="#idxref-3"><sup>[go]</sup></a>
+        </li>
+        <li>
+          Protocol <a class="index-return" href="#idxref-47"><sup>[go]</sup></a>
+          <ul>
+            <li>
+              HTTP <a class="index-return" href="#idxref-47"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+        <li>
+          Protocol <a class="index-return" href="#idxref-8"><sup>[go]</sup></a>
+          <ul>
+            <li>
+              Security <a class="index-return" href="#idxref-8"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+        <li>
+          Python <a class="index-return" href="#idxref-13"><sup>[go]</sup></a>
+        </li>
+        <li>
+          Python <a class="index-return" href="#idxref-36"><sup>[go]</sup></a>
+        </li>
+      </ul>
+    </dd>
+  </dl>
+  <dl>
+    <dt>
+      S
+    </dt>
+    <dd>
+      <ul>
+        <li>
+          Sabbath, the <a class="index-return" href="#idxref-23"><sup>[go]</sup></a>
+        </li>
+        <li>
+          Sabbath, the <a class="index-return" href="#idxref-20"><sup>[go]</sup></a>
+        </li>
+      </ul>
+    </dd>
+  </dl>
+  <dl>
+    <dt>
+      T
+    </dt>
+    <dd>
+      <ul>
+        <li>
+          term <a class="index-return" href="#idxref-16"><sup>[go]</sup></a>
+        </li>
+        <li>
+          term <a class="index-return" href="#idxref-28"><sup>[go]</sup></a>
+        </li>
+        <li>
+          term <a class="index-return" href="#idxref-29"><sup>[go]</sup></a>
+        </li>
+        <li>
+          Term <a class="index-return" href="#idxref-12"><sup>[go]</sup></a>
+          <ul>
+            <li>
+              param2 <a class="index-return" href="#idxref-12"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+        <li>
+          The API <a class="index-return" href="#idxref-15"><sup>[go]</sup></a>
+          <ul>
+            <li>
+              Programming Interface <a class="index-return" href="#idxref-15"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+        <li>
+          The API <a class="index-return" href="#idxref-38"><sup>[go]</sup></a>
+          <ul>
+            <li>
+              Programming Interface <a class="index-return" href="#idxref-38"><sup>[go]</sup></a>
+            </li>
+          </ul>
+        </li>
+        <li>
+          TLS <a class="index-return" href="#idxref-9"><sup>[go]</sup></a>
+        </li>
+        <li>
+          TLS <a class="index-return" href="#idxref-35"><sup>[go]</sup></a>
+        </li>
+      </ul>
+    </dd>
+  </dl>
+</div>
+<script>
+// Hamburger menu functionality
+(function() {
+  function initHamburgerMenu() {
+    var hamburger = document.getElementById('hamburger-menu');
+    var sidebar = document.querySelector('.main-toc, .sidebar');
+    var overlay = document.getElementById('mobile-menu-overlay');
+    if (!hamburger || !sidebar) return;
+    function toggleMenu() {
+      var isOpen = sidebar.classList.contains('mobile-open');
+      if (isOpen) {
+        sidebar.classList.remove('mobile-open');
+        hamburger.classList.remove('active');
+        if (overlay) overlay.classList.remove('active');
+      } else {
+        sidebar.classList.add('mobile-open');
+        hamburger.classList.add('active');
+        if (overlay) overlay.classList.add('active');
+      }
+    }
+    hamburger.addEventListener('click', function(e) {
+      e.stopPropagation();
+      toggleMenu();
+    });
+    if (overlay) {
+      overlay.addEventListener('click', function() {
+        toggleMenu();
+      });
+    }
+    // Close menu when clicking on a sidebar link (mobile only)
+    if (window.innerWidth <= 768) {
+      var sidebarLinks = sidebar.querySelectorAll('a');
+      sidebarLinks.forEach(function(link) {
+        link.addEventListener('click', function() {
+          setTimeout(function() {
+            sidebar.classList.remove('mobile-open');
+            hamburger.classList.remove('active');
+            if (overlay) overlay.classList.remove('active');
+          }, 100);
+        });
+      });
+    }
+    // Close menu on window resize if going to desktop
+    window.addEventListener('resize', function() {
+      if (window.innerWidth > 768) {
+        sidebar.classList.remove('mobile-open');
+        hamburger.classList.remove('active');
+        if (overlay) overlay.classList.remove('active');
+      }
+    });
+  }
+  // Initialize when DOM is ready
+  if (document.readyState === 'loading') {
+    document.addEventListener('DOMContentLoaded', initHamburgerMenu);
+  } else {
+    initHamburgerMenu();
+  }
+})();
+</script>
+<script>
+  (function() {
+    // Clone the page TOC for floating TOC
+    function initFloatingTOC() {
+      var pageTOC = document.getElementById('page-toc-top');
+      var floatingTOCContent = document.getElementById('floating-toc-content');
+      var floatingTOC = document.getElementById('floating-toc');
+      if (!pageTOC || !floatingTOCContent || !floatingTOC) return;
+      // Clone the TOC structure
+      var tocClone = pageTOC.cloneNode(true);
+      tocClone.id = 'floating-toc-clone';
+      floatingTOCContent.appendChild(tocClone);
+      // Update all links to use smooth scrolling
+      var allTOCLinks = document.querySelectorAll('.page-toc a, .floating-toc-content a');
+      allTOCLinks.forEach(function(link) {
+        link.addEventListener('click', function(e) {
+          var href = this.getAttribute('href');
+          if (href && href.startsWith('#')) {
+            e.preventDefault();
+            var targetId = href.substring(1);
+            var targetElement = document.getElementById(targetId);
+            if (targetElement) {
+              var offset = 20; // Offset from top
+              // Function to calculate absolute position from document top
+              function getAbsoluteTop(element) {
+                var top = 0;
+                while (element) {
+                  top += element.offsetTop;
+                  element = element.offsetParent;
+                }
+                return top;
+              }
+              var absoluteTop = getAbsoluteTop(targetElement);
+              var scrollTop = window.pageYOffset || document.documentElement.scrollTop;
+              var offsetPosition = absoluteTop - offset;
+              // Only scroll if we're not already at the target position
+              if (Math.abs(scrollTop - offsetPosition) > 10) {
+                window.scrollTo({
+                  top: Math.max(0, offsetPosition),
+                  behavior: 'smooth'
+                });
+              }
+              // Update URL hash without triggering scroll
+              if (history.pushState) {
+                history.pushState(null, null, href);
+              }
+            }
+          }
+        });
+      });
+      // Handle scroll to show/hide floating TOC
+      var tocTop = pageTOC.getBoundingClientRect().top + window.pageYOffset;
+      var tocBottom = tocTop + pageTOC.offsetHeight;
+      function updateFloatingTOC() {
+        var scrollY = window.pageYOffset || document.documentElement.scrollTop;
+        if (scrollY > tocBottom) {
+          floatingTOC.classList.add('visible');
+        } else {
+          floatingTOC.classList.remove('visible');
+        }
+      }
+      // Throttle scroll events
+      var ticking = false;
+      window.addEventListener('scroll', function() {
+        if (!ticking) {
+          window.requestAnimationFrame(function() {
+            updateFloatingTOC();
+            ticking = false;
+          });
+          ticking = true;
+        }
+      });
+      // Initial check
+      updateFloatingTOC();
+    }
+    // Initialize when DOM is ready
+    if (document.readyState === 'loading') {
+      document.addEventListener('DOMContentLoaded', initFloatingTOC);
+    } else {
+      initFloatingTOC();
+    }
+  })();
+</script>
+<footer class="page-footer"><p>Copyright 2025 Brett Terpstra, All Rights Reserved | MIT License</p></footer></body>
+</html>