This is Apex.
\n```\n\nBy default Apex reports `unified` with a broad feature set. Pass an\nexplicit mode when matching another Markdown processor, or when you want\ncitations and indices enabled:\n\n```js\nconst { convert } = require(\"@apexmarkdown/apex\");\n\nconst html = convert(markdown, {\n mode: \"gfm\",\n unsafe: false\n});\n```\n\n## Why Apex?\n\n- One processor for CommonMark, GFM, MultiMarkdown, Kramdown, Quarto, and\n Apex's combined `unified` mode.\n- Tables, footnotes, definition lists, attributes, callouts, math, Critic\n Markup, citations, wiki links, file includes, and more.\n- HTML, normalized Markdown, JSON AST, terminal, man page, and TOC output.\n- Native prebuilt binaries with no system `cmark-gfm` or `libyaml`\n installation.\n- Bundled TypeScript declarations.\n\nSee the [Apex syntax guide](https://github.com/ApexMarkdown/apex/wiki/Syntax)\nand [mode comparison](https://github.com/ApexMarkdown/apex/wiki/Modes) for\nthe supported Markdown syntax.\n\n## Common recipes\n\n### GitHub Flavored Markdown\n\n```js\nconst html = convert(markdown, { mode: \"gfm\" });\n```\n\nGFM mode enables tables, task lists, strikethrough, and autolinks while\nusing conservative raw-HTML handling.\n\n### Enable selected extensions\n\nOptions override the defaults selected by `mode`:\n\n```js\nconst html = convert(markdown, {\n mode: \"commonmark\",\n enableTables: true,\n enableFootnotes: true,\n enableCallouts: true\n});\n```\n\n### Create a complete HTML document\n\n```js\nconst document = convert(markdown, {\n standalone: true,\n documentTitle: \"Release notes\",\n stylesheetPaths: [\"./site.css\"],\n pretty: true\n});\n```\n\n### Render for a terminal\n\n```js\nconst output = convert(markdown, {\n outputFormat: \"terminal256\",\n terminalWidth: 100,\n themeName: \"dark\"\n});\n```\n\n## API\n\n### `convert(markdown, options?)`\n\nSynchronously converts a Markdown string and returns a string in the selected\noutput format.\n\n```ts\nfunction convert(markdown: string, options?: ApexOptions): string;\n```\n\n`markdown` must be a string. `options` must be an object whose own properties\nare documented below. Unknown options, invalid enum values, wrong value types,\nnon-finite numbers, fractional integers, and integers outside the signed\n32-bit range throw a `TypeError`. A native conversion failure throws an\n`Error`.\n\n### `version`\n\nA string containing the bundled Apex engine version:\n\n```js\nconst { version } = require(\"@apexmarkdown/apex\");\nconsole.log(version); // for example, \"1.1.12\"\n```\n\n`version` is a string, not a function.\n\n### TypeScript\n\nThe package includes declarations for `convert`, `version`, `ApexOptions`,\nand every string union used by the API:\n\n```ts\nimport type { ApexOptions } from \"@apexmarkdown/apex\";\n\nconst apex: typeof import(\"@apexmarkdown/apex\") =\n require(\"@apexmarkdown/apex\");\n\nconst options: ApexOptions = {\n mode: \"gfm\",\n generateHeaderIds: true\n};\n\nconst html = apex.convert(\"# Typed\", options);\n```\n\n## Modes and defaults\n\n`mode` selects a complete set of defaults first. Every other supplied option\nthen overrides that set.\n\n- `commonmark` — strict CommonMark with most extensions disabled.\n- `gfm` — GitHub tables, task lists, strikethrough, and autolinks.\n- `multimarkdown` — MultiMarkdown metadata, tables, footnotes, includes,\n definition lists, math, and citations.\n- `kramdown` — Kramdown-compatible attributes, footnotes, definition lists,\n and related syntax.\n- `unified` — Apex's combined feature set, including citations and indices.\n- `quarto` — Quarto-oriented parsing and extensions.\n\nIf `mode` is omitted, Apex starts from its no-mode defaults, which report\n`unified` but leave citations and index processing disabled. Pass\n`mode: \"unified\"` when you want citations and indices enabled by default.\n\nDefaults otherwise vary by mode. The descriptions below explain each\noverride rather than claiming one value across every mode.\n\n## Complete option reference\n\n\n\nAll option names are camelCase and case-sensitive.\n\n### Parser modes and feature sets\n\n- **`mode`** (`\"commonmark\" | \"gfm\" | \"multimarkdown\" | \"kramdown\" | \"unified\" | \"quarto\"`) — Select the base parser mode and its defaults.\n- **`enableTables`** (`boolean`) — Enable pipe tables.\n- **`enableFootnotes`** (`boolean`) — Enable reference and inline footnotes.\n- **`enableDefinitionLists`** (`boolean`) — Enable definition-list syntax.\n- **`enableSmartTypography`** (`boolean`) — Convert quotes, dashes, ellipses, and related punctuation.\n- **`enableMath`** (`boolean`) — Enable inline and display math syntax.\n- **`enableCriticMarkup`** (`boolean`) — Parse Critic Markup additions, deletions, substitutions, highlights, and comments.\n- **`enableWikiLinks`** (`boolean`) — Parse `[[wiki links]]`.\n- **`enableTaskLists`** (`boolean`) — Enable GFM task-list checkboxes.\n- **`enableAttributes`** (`boolean`) — Enable inline attribute lists and related attribute syntax.\n- **`enableCallouts`** (`boolean`) — Enable Bear/Obsidian `> [!TYPE]` callouts.\n- **`enablePyCallouts`** (`boolean`) — Enable Python-Markdown `!!!` callouts.\n- **`enableQuartoCallouts`** (`boolean`) — Enable Quarto callout blocks.\n- **`enableQuartoExtensions`** (`boolean`) — Enable the general Quarto extension set.\n- **`enableQuartoRaw`** (`boolean`) — Enable Quarto raw-content blocks.\n- **`enableQuartoExampleLists`** (`boolean`) — Enable Quarto example lists.\n- **`enableQuartoLineBlocks`** (`boolean`) — Enable Quarto line blocks.\n- **`enableQuartoRomanLists`** (`boolean`) — Enable Quarto Roman-numeral lists.\n- **`enableQuartoCodeAttrs`** (`boolean`) — Enable Quarto code-block attributes.\n- **`enableQuartoDiagrams`** (`boolean`) — Enable Quarto diagram handling.\n- **`enableQuartoShortcodes`** (`boolean`) — Enable Quarto shortcodes.\n- **`enableQuartoStrictLists`** (`boolean`) — Use Quarto's stricter list parsing.\n- **`enableQuartoXrefs`** (`boolean`) — Enable Quarto cross-references.\n- **`enableMarkedExtensions`** (`boolean`) — Enable Apex's Marked-compatible extensions.\n- **`enableDivs`** (`boolean`) — Enable fenced divs.\n- **`enableSpans`** (`boolean`) — Enable bracketed spans with attributes.\n- **`enableGridTables`** (`boolean`) — Enable Pandoc-style grid tables.\n\n### Plugins\n\n- **`enablePlugins`** (`boolean`) — Run Apex plugin processing.\n- **`allowExternalPluginDetection`** (`boolean`) — Allow discovery of external plugins.\n\nPlugins can execute external code. Enable them only when the installed plugins\nand input are trusted.\n\n### Critic Markup\n\n- **`criticMode`** (`\"markup\" | \"accept\" | \"reject\"`) — Preserve Critic Markup, accept all tracked changes, or reject them.\n\n### Metadata and file inclusion\n\n- **`stripMetadata`** (`boolean`) — Remove parsed metadata blocks from rendered content.\n- **`enableMetadataVariables`** (`boolean`) — Expand metadata variables such as `[%key]`.\n- **`enableMetadataTransforms`** (`boolean`) — Enable transforms in metadata-variable expressions.\n- **`enableFileIncludes`** (`boolean`) — Resolve Apex, MultiMarkdown, and compatible file-include syntax.\n- **`maxIncludeDepth`** (`number`) — Set the maximum recursive include depth as a signed 32-bit integer.\n- **`baseDirectory`** (`string`) — Resolve relative includes and file-backed resources from this directory.\n- **`inputFilePath`** (`string`) — Supply the source path exposed to plugins and path-aware processing.\n\nFile includes and file-backed options can read local files. Set\n`baseDirectory` deliberately when converting untrusted input.\n\n### Output\n\n- **`outputFormat`** (`\"html\" | \"json\" | \"jsonFiltered\" | \"markdown\" | \"mmd\" | \"commonmark\" | \"kramdown\" | \"gfm\" | \"terminal\" | \"terminal256\" | \"man\" | \"manHtml\" | \"toc\"`) — Select the returned representation.\n- **`unsafe`** (`boolean`) — Allow raw HTML instead of applying cmark's safe-HTML handling.\n- **`validateUtf8`** (`boolean`) — Replace invalid UTF-8 sequences with the Unicode replacement character.\n- **`githubPreLang`** (`boolean`) — Put fenced-code languages on `` in GitHub style.\n- **`standalone`** (`boolean`) — Emit a complete document instead of a fragment.\n- **`pretty`** (`boolean`) — Pretty-print generated HTML.\n- **`xhtml`** (`boolean`) — Render void elements using XHTML syntax.\n- **`strictXhtml`** (`boolean`) — Use stricter polyglot XHTML scaffolding for standalone output.\n- **`stylesheetPaths`** (`string[]`) — Add stylesheet paths to standalone output.\n- **`documentTitle`** (`string`) — Set the standalone document title.\n\n`unified` mode permits raw HTML by default, while strict compatibility modes\nmay not. Set `unsafe: false` explicitly when processing untrusted Markdown\nthat must not pass raw HTML through.\n\n### Terminal rendering\n\n- **`themeName`** (`string`) — Select the terminal rendering theme.\n- **`terminalWidth`** (`number`) — Set the terminal width as a signed 32-bit integer; `0` lets Apex determine it.\n- **`paginate`** (`boolean`) — Mark terminal output for pagination. The Node binding returns the rendered string and does not open a pager.\n- **`paginateSymbols`** (`boolean`) — Prefer pager-compatible symbol rendering for terminal images.\n- **`terminalInlineImages`** (`boolean`) — Render terminal images through a supported external viewer.\n- **`terminalImageWidth`** (`number`) — Set inline terminal image width in character cells.\n\n### Line breaks, headings, and TOCs\n\n- **`hardbreaks`** (`boolean`) — Treat soft line endings as hard line breaks.\n- **`nobreaks`** (`boolean`) — Render soft breaks without inserting line breaks.\n- **`generateHeaderIds`** (`boolean`) — Generate IDs for headings.\n- **`headerAnchors`** (`boolean`) — Emit heading anchor elements instead of relying only on IDs.\n- **`idFormat`** (`\"gfm\" | \"mmd\"`) — Select GFM- or MultiMarkdown-style generated IDs.\n- **`tocMin`** (`number`) — Set the minimum heading level included in generated TOCs.\n- **`tocMax`** (`number`) — Set the maximum heading level included in generated TOCs.\n\n### Tables and lists\n\n- **`relaxedTables`** (`boolean`) — Accept relaxed tables without a standard separator row.\n- **`captionPosition`** (`\"above\" | \"below\"`) — Place generated table captions above or below the table.\n- **`perCellAlignment`** (`boolean`) — Enable alignment markers on individual table cells.\n- **`allowMixedListMarkers`** (`boolean`) — Keep mixed bullet markers in one list where the mode permits.\n- **`allowAlphaLists`** (`boolean`) — Enable alphabetic ordered-list markers.\n\n### Inline syntax and autolinks\n\n- **`enableSupSub`** (`boolean`) — Enable superscript and subscript syntax.\n- **`enableStrikethrough`** (`boolean`) — Enable `~~strikethrough~~`.\n- **`enableAutolink`** (`boolean`) — Automatically link recognized URLs and email addresses.\n- **`obfuscateEmails`** (`boolean`) — Obfuscate email addresses in generated links.\n\n### Images\n\n- **`embedImages`** (`boolean`) — Embed supported local images as base64 data URLs.\n- **`enableImageCaptions`** (`boolean`) — Render eligible images as figures with captions.\n- **`titleCaptionsOnly`** (`boolean`) — Require an image title instead of falling back to alt text for captions.\n\n### Citations and bibliographies\n\n- **`enableCitations`** (`boolean`) — Parse citation syntax and process bibliography data. Unlike the Apex CLI, setting bibliography options here does not enable citations automatically.\n- **`bibliographyFiles`** (`string[]`) — Load BibTeX, CSL JSON, or CSL YAML bibliography files. Pair with `enableCitations: true`.\n- **`cslFile`** (`string`) — Apply a Citation Style Language file. Pair with `enableCitations: true`.\n- **`suppressBibliography`** (`boolean`) — Process citations without appending a bibliography.\n- **`linkCitations`** (`boolean`) — Link in-text citations to bibliography entries.\n- **`showTooltips`** (`boolean`) — Add citation details as tooltips where supported.\n- **`nocite`** (`string`) — Include uncited bibliography entries using a nocite expression.\n\nSee the [citation guide](https://github.com/ApexMarkdown/apex/wiki/Citations)\nfor syntax and supported bibliography formats.\n\n### Indices\n\n- **`enableIndices`** (`boolean`) — Parse index entries and generate an index.\n- **`enableMmarkIndexSyntax`** (`boolean`) — Enable mmark index syntax.\n- **`enableTextindexSyntax`** (`boolean`) — Enable TextIndex syntax.\n- **`enableLeanpubIndexSyntax`** (`boolean`) — Enable Leanpub index syntax.\n- **`suppressIndex`** (`boolean`) — Parse index entries without appending the generated index.\n- **`groupIndexByLetter`** (`boolean`) — Group generated index entries by initial letter.\n\n### Wiki links\n\n- **`wikilinkSpace`** (`\"dash\" | \"none\" | \"underscore\" | \"space\"`) — Choose how spaces are written in wiki-link targets.\n- **`wikilinkExtension`** (`string`) — Append an extension to generated wiki-link targets.\n- **`wikilinkSanitize`** (`boolean`) — Sanitize generated wiki-link targets.\n\n### Styles, scripts, accessibility, and emoji\n\n- **`scriptTags`** (`string[]`) — Add raw script-tag snippets to standalone output.\n- **`embedStylesheet`** (`boolean`) — Embed stylesheet content instead of linking it.\n- **`enableAria`** (`boolean`) — Add supported ARIA roles, labels, and relationships.\n- **`enableEmojiAutocorrect`** (`boolean`) — Normalize supported emoji-related syntax and names.\n\n### Syntax highlighting\n\n- **`codeHighlighter`** (`string`) — Select an external highlighter such as Pygments, Skylighting, or Shiki.\n- **`codeLineNumbers`** (`boolean`) — Request line numbers from syntax highlighting.\n- **`highlightLanguageOnly`** (`boolean`) — Highlight only code blocks that declare a language.\n- **`codeHighlightTheme`** (`string`) — Select the external highlighter theme.\n\nExternal highlighting may execute a highlighter installed on the system.\n\n### Integration-specific rendering\n\n- **`enableWidont`** (`boolean`) — Prevent a lone final word where supported by moving it with a nonbreaking space.\n- **`codeIsPoetry`** (`boolean`) — Apply poetry-oriented handling to code-like text.\n- **`enableMarkdownInHtml`** (`boolean`) — Parse Markdown inside eligible HTML blocks.\n- **`randomFootnoteIds`** (`boolean`) — Randomize generated footnote IDs to avoid collisions.\n- **`enableHashtags`** (`boolean`) — Recognize hashtags.\n- **`styleHashtags`** (`boolean`) — Add styling hooks to recognized hashtags.\n- **`proofreaderMode`** (`boolean`) — Enable proofreader-oriented rendering behavior.\n- **`hrPageBreak`** (`boolean`) — Treat horizontal rules as page breaks where supported.\n- **`titleFromH1`** (`boolean`) — Derive the document title from the first level-one heading.\n- **`pageBreakBeforeFootnotes`** (`boolean`) — Insert a page break before the footnotes section.\n\n### AST filters\n\n- **`astFilterCommands`** (`string[]`) — Run Pandoc-style JSON AST filter commands in order.\n- **`astFilterStrict`** (`boolean`) — Fail conversion when an AST filter fails instead of continuing.\n\nAST filters execute external commands. Do not enable filters supplied by\nuntrusted input.\n\n\n\n## Supported platforms\n\nPrebuilt native addons are published for:\n\n- macOS arm64\n- macOS x64\n- Linux arm64\n- Linux x64\n\nThe package requires Node.js 20 or newer. Windows and other\nplatform/architecture combinations do not currently have prebuilt addons.\nNo system `cmark-gfm` or `libyaml` installation is required on supported\nplatforms; both libraries are statically linked.\n\nIf installation omits the optional platform package, loading Apex throws an\nerror identifying the detected platform. Ensure optional dependencies are not\ndisabled by your package-manager configuration.\n\n## Native and security considerations\n\n`convert()` runs synchronously on the calling thread. For large documents or\nhigh-throughput servers, consider performing conversions in worker threads.\n\nSome options intentionally access the filesystem or execute external\nprograms: plugins, file includes, bibliography and CSL files, stylesheet and\nimage embedding, syntax highlighters, and AST filters. Restrict these features\nwhen processing untrusted Markdown.\n\n## Local development\n\n```bash\ngit clone --recurse-submodules https://github.com/ApexMarkdown/apex-node.git\ncd apex-node\nnpm install\nnpm run build\nnpm test\n```\n\nIf the repository was cloned without submodules:\n\n```bash\ngit submodule update --init --recursive\n```\n\nTo produce the prebuilt package for the current platform:\n\n```bash\nnpm run package:prebuild\n```\n\nThis writes `prebuilds/@apexmarkdown/apex--/`.\n\n## More documentation\n\n- [Apex documentation](https://github.com/ApexMarkdown/apex/wiki)\n- [Syntax](https://github.com/ApexMarkdown/apex/wiki/Syntax)\n- [Modes](https://github.com/ApexMarkdown/apex/wiki/Modes)\n- [Command-line options](https://github.com/ApexMarkdown/apex/wiki/Command-Line-Options)\n- [Citations](https://github.com/ApexMarkdown/apex/wiki/Citations)\n- [Tables](https://github.com/ApexMarkdown/apex/wiki/Tables)\n- [Apex CLI and C library](https://github.com/ApexMarkdown/apex)\n\n## License\n\nMIT\n","readmeFilename":"README.md"}