apex-ruby 1.0.6

data/ext/apex_ext/apex_src/include/apex/parser.h

@@ -0,0 +1,150 @@
+/**
+ * @file parser.h
+ * @brief Markdown parser interface
+ */
+
+#ifndef APEX_PARSER_H
+#define APEX_PARSER_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include "apex.h"
+
+/**
+ * Node types in the AST
+ */
+typedef enum {
+    APEX_NODE_DOCUMENT,
+    APEX_NODE_PARAGRAPH,
+    APEX_NODE_HEADING,
+    APEX_NODE_CODE_BLOCK,
+    APEX_NODE_HTML_BLOCK,
+    APEX_NODE_THEMATIC_BREAK,
+    APEX_NODE_BLOCK_QUOTE,
+    APEX_NODE_LIST,
+    APEX_NODE_LIST_ITEM,
+    APEX_NODE_TEXT,
+    APEX_NODE_SOFTBREAK,
+    APEX_NODE_LINEBREAK,
+    APEX_NODE_CODE,
+    APEX_NODE_HTML_INLINE,
+    APEX_NODE_EMPH,
+    APEX_NODE_STRONG,
+    APEX_NODE_LINK,
+    APEX_NODE_IMAGE,
+
+    /* Extended node types */
+    APEX_NODE_TABLE,
+    APEX_NODE_TABLE_ROW,
+    APEX_NODE_TABLE_CELL,
+    APEX_NODE_FOOTNOTE_REFERENCE,
+    APEX_NODE_FOOTNOTE_DEFINITION,
+    APEX_NODE_DEFINITION_LIST,
+    APEX_NODE_DEFINITION_TERM,
+    APEX_NODE_DEFINITION_DATA,
+    APEX_NODE_TASK_LIST_ITEM,
+    APEX_NODE_STRIKETHROUGH,
+    APEX_NODE_MATH,
+    APEX_NODE_CALLOUT,
+    APEX_NODE_WIKI_LINK,
+    APEX_NODE_CRITIC_ADDITION,
+    APEX_NODE_CRITIC_DELETION,
+    APEX_NODE_CRITIC_SUBSTITUTION,
+    APEX_NODE_CRITIC_HIGHLIGHT,
+    APEX_NODE_CRITIC_COMMENT,
+    APEX_NODE_METADATA,
+    APEX_NODE_TOC_MARKER,
+    APEX_NODE_PAGE_BREAK,
+} apex_node_type;
+
+/**
+ * AST node structure
+ */
+typedef struct apex_node {
+    apex_node_type type;
+    struct apex_node *parent;
+    struct apex_node *first_child;
+    struct apex_node *last_child;
+    struct apex_node *prev;
+    struct apex_node *next;
+
+    /* Node data */
+    char *literal;          /**< Text content for text nodes */
+    int start_line;         /**< Source start line */
+    int start_column;       /**< Source start column */
+    int end_line;           /**< Source end line */
+    int end_column;         /**< Source end column */
+
+    /* Type-specific data */
+    union {
+        struct {
+            int level;      /**< Heading level (1-6) */
+        } heading;
+
+        struct {
+            char *info;     /**< Language/info string */
+            bool fenced;    /**< Is fenced code block */
+        } code_block;
+
+        struct {
+            char *url;
+            char *title;
+        } link;
+
+        struct {
+            bool checked;   /**< Task list checkbox state */
+        } task_item;
+
+        struct {
+            char *type;     /**< Callout type (NOTE, WARNING, etc) */
+            char *title;    /**< Callout title */
+            bool collapsible;
+            bool default_open;
+        } callout;
+
+        struct {
+            bool is_inline; /**< Inline vs display math */
+        } math;
+    } data;
+} apex_node;
+
+/**
+ * Create parser
+ *
+ * @param options Parser options
+ * @return Parser instance
+ */
+void *apex_parser_new(const apex_options *options);
+
+/**
+ * Free parser
+ *
+ * @param parser Parser instance
+ */
+void apex_parser_free(void *parser);
+
+/**
+ * Parse Markdown text into AST
+ *
+ * @param parser Parser instance
+ * @param markdown Input text
+ * @param length Text length
+ * @return Root node of AST
+ */
+apex_node *apex_parse(void *parser, const char *markdown, size_t length);
+
+/**
+ * Free AST node and all children
+ *
+ * @param node Node to free
+ */
+void apex_node_free(apex_node *node);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* APEX_PARSER_H */
+

data/ext/apex_ext/apex_src/include/apex/renderer.h

@@ -0,0 +1,39 @@
+/**
+ * @file renderer.h
+ * @brief AST renderer interface
+ */
+
+#ifndef APEX_RENDERER_H
+#define APEX_RENDERER_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include "parser.h"
+#include "buffer.h"
+
+/**
+ * Render AST to HTML
+ *
+ * @param root Root node of AST
+ * @param options Rendering options
+ * @return HTML string (must be freed with apex_free)
+ */
+char *apex_render_html(apex_node *root, const apex_options *options);
+
+/**
+ * Render AST to XML
+ *
+ * @param root Root node of AST
+ * @param options Rendering options
+ * @return XML string (must be freed with apex_free)
+ */
+char *apex_render_xml(apex_node *root, const apex_options *options);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* APEX_RENDERER_H */
+

data/ext/apex_ext/apex_src/man/apex-config.5

@@ -0,0 +1,374 @@
+.\" Automatically generated by Pandoc 3.8.3
+.\"
+.TH "APEX\-CONFIG" "5" "December 2025" ""
+.SH NAME
+apex\-config \- Apex configuration file format
+.SH DESCRIPTION
+Apex supports flexible configuration through metadata files that allow
+you to define defaults once and reuse them across many documents, while
+still allowing per\-document and per\-invocation overrides.
+.PP
+Configuration can come from three main sources:
+.IP "1." 3
+\f[B]Global configuration file\f[R] \-
+\f[CR]$XDG_CONFIG_HOME/apex/config.yml\f[R] or
+\f[CR]\(ti/.config/apex/config.yml\f[R]
+.IP "2." 3
+\f[B]External metadata files\f[R] \- Any file passed via
+\f[CR]\-\-meta\-file\f[R]
+.IP "3." 3
+\f[B]Per\-document metadata\f[R] \- YAML, MultiMarkdown, or
+Pandoc\-style metadata in the document
+.PP
+Command\-line flags always override configuration file settings.
+.SH GLOBAL CONFIG FILE
+When you run \f[B]apex\f[R](1) without an explicit
+\f[CR]\-\-meta\-file\f[R], Apex automatically checks for a global
+configuration file:
+.IP \(bu 2
+If \f[CR]$XDG_CONFIG_HOME\f[R] is set:
+\f[CR]$XDG_CONFIG_HOME/apex/config.yml\f[R]
+.IP \(bu 2
+Otherwise: \f[CR]\(ti/.config/apex/config.yml\f[R]
+.PP
+If the file exists, Apex loads it as if you had passed it via
+\f[CR]\-\-meta\-file\f[R], and merges its metadata with the document and
+any \f[CR]\-\-meta\f[R] command\-line metadata.
+.PP
+This makes \f[CR]config.yml\f[R] ideal for defining project\-agnostic
+defaults such as:
+.IP \(bu 2
+Default \f[CR]mode\f[R] (e.g.\ \f[CR]unified\f[R], \f[CR]gfm\f[R],
+\f[CR]mmd\f[R])
+.IP \(bu 2
+Default \f[CR]language\f[R] and \f[CR]quoteslanguage\f[R]
+.IP \(bu 2
+Common feature flags (\f[CR]pretty\f[R], \f[CR]standalone\f[R],
+\f[CR]indices\f[R], \f[CR]wikilinks\f[R], etc.)
+.IP \(bu 2
+Default bibliography style
+.SS Example \f[CR]config.yml\f[R]
+.IP
+.EX
+\-\-\-
+\f[I]# Default processor mode and output style\f[R]
+mode\f[B]:\f[R] unified
+standalone\f[B]:\f[R] true
+pretty\f[B]:\f[R] true
+
+\f[I]# Locale and quotation style\f[R]
+language\f[B]:\f[R] en
+quoteslanguage\f[B]:\f[R] english
+
+\f[I]# Common feature flags\f[R]
+autolink\f[B]:\f[R] true
+includes\f[B]:\f[R] true
+relaxed\-tables\f[B]:\f[R] true
+sup\-sub\f[B]:\f[R] true
+
+\f[I]# Index and bibliography defaults\f[R]
+indices\f[B]:\f[R] true
+group\-index\-by\-letter\f[B]:\f[R] true
+bibliography\f[B]:\f[R] references.bib
+csl\f[B]:\f[R] apa.csl
+\-\-\-
+.EE
+.SH EXTERNAL METADATA FILES
+For project\-specific or task\-specific configurations, use
+\f[CR]\-\-meta\-file\f[R] to point to a reusable metadata file:
+.IP
+.EX
+apex document.md \-\-meta\-file project\-defaults.yml
+.EE
+.PP
+These files use the same metadata keys as \f[CR]config.yml\f[R] and
+document front matter.
+.SS Example project config
+.IP
+.EX
+\-\-\-
+mode\f[B]:\f[R] unified
+standalone\f[B]:\f[R] true
+pretty\f[B]:\f[R] true
+
+\f[I]# Project\-specific bibliography\f[R]
+bibliography\f[B]:\f[R] project\-refs.bib
+csl\f[B]:\f[R] chicago\-note\-bibliography.csl
+
+\f[I]# Enable wiki links and relaxed tables for this project\f[R]
+wikilinks\f[B]:\f[R] true
+relaxed\-tables\f[B]:\f[R] true
+\-\-\-
+.EE
+.SH PER\-DOCUMENT METADATA
+Each document can define its own metadata in YAML, MultiMarkdown, or
+Pandoc formats.
+Apex extracts this metadata before processing, merges it with any
+file/config metadata, and then applies it to options.
+.SS YAML front matter example
+.IP
+.EX
+\f[I]\-\-\-\f[R]
+\f[BI]title:\f[R]\f[I] My Research Paper\f[R]
+\f[BI]author:\f[R]\f[I] Jane Doe\f[R]
+\f[BI]mode:\f[R]\f[I] unified\f[R]
+\f[BI]standalone:\f[R]\f[I] true\f[R]
+\f[BI]pretty:\f[R]\f[I] true\f[R]
+\f[BI]indices:\f[R]\f[I] false\f[R]
+\f[BI]wikilinks:\f[R]\f[I] true\f[R]
+\f[BI]bibliography:\f[R]\f[I] references.bib\f[R]
+\f[BI]language:\f[R]\f[I] en\f[R]
+\f[BI]quoteslanguage:\f[R]\f[I] english\f[R]
+\f[I]\-\-\-\f[R]
+
+# Introduction
+\&...
+.EE
+.SS MultiMarkdown metadata example
+.IP
+.EX
+\f[BI]Title:\f[R]\f[I] My Research Paper\f[R]
+\f[BI]Author:\f[R]\f[I] Jane Doe\f[R]
+\f[BI]Mode:\f[R]\f[I] unified\f[R]
+\f[BI]Standalone:\f[R]\f[I] true\f[R]
+\f[BI]Pretty:\f[R]\f[I] true\f[R]
+\f[BI]Indices:\f[R]\f[I] false\f[R]
+\f[BI]WikiLinks:\f[R]\f[I] true\f[R]
+\f[BI]Bibliography:\f[R]\f[I] references.bib\f[R]
+\f[BI]Language:\f[R]\f[I] en\f[R]
+\f[BI]Quotes Language:\f[R]\f[I] english\f[R]
+
+# Introduction
+\&...
+.EE
+.PP
+Apex normalizes keys (case\-insensitive, ignores spaces and dashes), so
+\f[CR]Quotes Language\f[R], \f[CR]quoteslanguage\f[R], and
+\f[CR]quotes\-language\f[R] are treated equivalently.
+.SH PRECEDENCE AND MERGING
+When Apex builds the final configuration for a run, it merges all
+sources in this order:
+.IP "1." 3
+\f[B]File metadata\f[R] (lowest precedence)
+.RS 4
+.IP \(bu 2
+Global \f[CR]config.yml\f[R] if present and no explicit
+\f[CR]\-\-meta\-file\f[R] was given
+.IP \(bu 2
+Any metadata file provided via \f[CR]\-\-meta\-file\f[R]
+.RE
+.IP "2." 3
+\f[B]Document metadata\f[R]
+.RS 4
+.IP \(bu 2
+YAML/MultiMarkdown/Pandoc metadata inside the document
+.RE
+.IP "3." 3
+\f[B]Command\-line metadata\f[R]
+.RS 4
+.IP \(bu 2
+Values passed via \f[CR]\-\-meta KEY=VALUE\f[R]
+.RE
+.IP "4." 3
+\f[B]Command\-line flags\f[R]
+.RS 4
+.IP \(bu 2
+Flags like \f[CR]\-\-mode\f[R], \f[CR]\-\-pretty\f[R],
+\f[CR]\-\-no\-tables\f[R], etc.
+.RE
+.PP
+Later sources override earlier ones.
+In practice:
+.IP \(bu 2
+A document can override defaults from \f[CR]config.yml\f[R] or
+\f[CR]\-\-meta\-file\f[R]
+.IP \(bu 2
+\f[CR]\-\-meta\f[R] values can override both document and file metadata
+.IP \(bu 2
+Explicit CLI flags still behave as final overrides where applicable
+.PP
+\f[B]Note:\f[R] If \f[CR]mode\f[R] is specified in metadata (file or
+document), Apex resets options to that mode\(cqs defaults before
+applying other metadata keys, so the mode behaves as if you had passed
+it on the command line first.
+.SH CONFIGURATION KEYS
+Configuration keys correspond closely to Apex command\-line options.
+Most options can be controlled via metadata in \f[CR]config.yml\f[R],
+\f[CR]\-\-meta\-file\f[R] files, or per\-document metadata.
+.SS Boolean options
+Boolean keys accept any of the following values (case\-insensitive):
+.IP \(bu 2
+\f[CR]true\f[R] / \f[CR]false\f[R]
+.IP \(bu 2
+\f[CR]yes\f[R] / \f[CR]no\f[R]
+.IP \(bu 2
+\f[CR]1\f[R] / \f[CR]0\f[R]
+.PP
+\f[B]Supported boolean keys include:\f[R]
+.IP \(bu 2
+\f[CR]indices\f[R] \- Enable index processing
+.IP \(bu 2
+\f[CR]wikilinks\f[R] \- Enable wiki link syntax (\f[CR][[Page]]\f[R])
+.IP \(bu 2
+\f[CR]includes\f[R] \- Enable file inclusion
+.IP \(bu 2
+\f[CR]relaxed\-tables\f[R] \- Enable relaxed table parsing
+.IP \(bu 2
+\f[CR]alpha\-lists\f[R] \- Enable alphabetic list markers
+.IP \(bu 2
+\f[CR]mixed\-lists\f[R] \- Allow mixing list marker types at the same
+level
+.IP \(bu 2
+\f[CR]sup\-sub\f[R] \- Enable MultiMarkdown\-style superscript/subscript
+.IP \(bu 2
+\f[CR]autolink\f[R] \- Enable automatic URL/email linking
+.IP \(bu 2
+\f[CR]transforms\f[R] \- Enable metadata transforms
+(\f[CR][%key:transform]\f[R])
+.IP \(bu 2
+\f[CR]unsafe\f[R] \- Allow raw HTML in output
+.IP \(bu 2
+\f[CR]tables\f[R] \- Enable/disable table support
+.IP \(bu 2
+\f[CR]footnotes\f[R] \- Enable/disable footnote support
+.IP \(bu 2
+\f[CR]smart\f[R] \- Enable/disable smart typography
+.IP \(bu 2
+\f[CR]math\f[R] \- Enable/disable math support
+.IP \(bu 2
+\f[CR]ids\f[R] \- Enable/disable automatic header IDs
+.IP \(bu 2
+\f[CR]header\-anchors\f[R] \- Use \f[CR]<a>\f[R] anchors instead of
+plain \f[CR]id\f[R] attributes
+.IP \(bu 2
+\f[CR]embed\-images\f[R] \- Enable base64 image embedding
+.IP \(bu 2
+\f[CR]link\-citations\f[R] \- Link citations to bibliography entries
+.IP \(bu 2
+\f[CR]show\-tooltips\f[R] \- Add tooltips to citations
+.IP \(bu 2
+\f[CR]suppress\-bibliography\f[R] \- Suppress bibliography output
+.IP \(bu 2
+\f[CR]suppress\-index\f[R] \- Suppress index output while still creating
+markers
+.IP \(bu 2
+\f[CR]group\-index\-by\-letter\f[R] \- Group index entries
+alphabetically
+.IP \(bu 2
+\f[CR]obfuscate\-emails\f[R] \- Hex\-encode \f[CR]mailto:\f[R] links and
+visible email addresses
+.IP \(bu 2
+\f[CR]pretty\f[R] \- Pretty\-print HTML
+.IP \(bu 2
+\f[CR]standalone\f[R] \- Generate a full HTML document
+(\f[CR]<html>\f[R], \f[CR]<head>\f[R], \f[CR]<body>\f[R])
+.IP \(bu 2
+\f[CR]hardbreaks\f[R] \- Treat newlines as \f[CR]<br>\f[R]
+.IP \(bu 2
+\f[CR]plugins\f[R] \- Enable plugin processing (see
+\f[B]apex\-plugins\f[R](7))
+.SS String options
+String keys take a free\-form string value (sometimes with a constrained
+set of options):
+.IP \(bu 2
+\f[CR]mode\f[R]
+.RS 2
+.IP \(bu 2
+Values: \f[CR]commonmark\f[R], \f[CR]gfm\f[R],
+\f[CR]mmd\f[R]/\f[CR]multimarkdown\f[R], \f[CR]kramdown\f[R],
+\f[CR]unified\f[R]
+.RE
+.IP \(bu 2
+\f[CR]id\-format\f[R]
+.RS 2
+.IP \(bu 2
+Values: \f[CR]gfm\f[R], \f[CR]mmd\f[R], \f[CR]kramdown\f[R]
+.RE
+.IP \(bu 2
+\f[CR]title\f[R]
+.RS 2
+.IP \(bu 2
+Document title (used especially in standalone mode)
+.RE
+.IP \(bu 2
+\f[CR]style\f[R] / \f[CR]css\f[R]
+.RS 2
+.IP \(bu 2
+Stylesheet path for standalone documents
+.RE
+.IP \(bu 2
+\f[CR]base\-dir\f[R]
+.RS 2
+.IP \(bu 2
+Base directory used for resolving relative paths (images, includes,
+etc.)
+.RE
+.IP \(bu 2
+\f[CR]bibliography\f[R]
+.RS 2
+.IP \(bu 2
+Path to a bibliography file (\f[CR].bib\f[R], \f[CR].json\f[R],
+\f[CR].yml\f[R], \f[CR].yaml\f[R])
+.RE
+.IP \(bu 2
+\f[CR]csl\f[R]
+.RS 2
+.IP \(bu 2
+Path to a CSL style file
+.RE
+.IP \(bu 2
+\f[CR]language\f[R]
+.RS 2
+.IP \(bu 2
+BCP 47 or similar language tag (e.g.\ \f[CR]en\f[R], \f[CR]en\-US\f[R],
+\f[CR]fr\f[R]); sets the HTML \f[CR]lang\f[R] attribute
+.RE
+.IP \(bu 2
+\f[CR]quoteslanguage\f[R] / \f[CR]Quotes Language\f[R]
+.RS 2
+.IP \(bu 2
+Human\-readable language name used for quote styling
+(e.g.\ \f[CR]english\f[R], \f[CR]french\f[R], \f[CR]german\f[R])
+.RE
+.PP
+You can also use arbitrary keys for your own templates and transforms;
+Apex simply passes them through to the metadata system so they can be
+referenced via \f[CR][%key]\f[R] and \f[CR][%key:transform]\f[R].
+.SH EXAMPLES
+A typical setup might look like this:
+.IP "1." 3
+\f[B]Global defaults\f[R] in \f[CR]config.yml\f[R] for your overall
+writing style and locale.
+.IP "2." 3
+\f[B]Project config\f[R] via \f[CR]\-\-meta\-file project.yml\f[R] for
+bibliography and project\-specific settings.
+.IP "3." 3
+\f[B]Per\-document metadata\f[R] for title, author, and any exceptions
+to the defaults.
+.IP "4." 3
+Occasional \f[B]CLI overrides\f[R] for ad\-hoc one\-off changes
+(e.g.\ \f[CR]\-\-mode gfm\f[R] for a specific run).
+.PP
+Because all three configuration layers use the same metadata keys, you
+can gradually refine behavior without repeating yourself:
+.IP \(bu 2
+Put long\-lived, cross\-project settings in \f[CR]config.yml\f[R]
+.IP \(bu 2
+Put project\-scoped settings in \f[CR]\-\-meta\-file\f[R] configs
+.IP \(bu 2
+Put document\-specific settings in front matter
+.SH SEE ALSO
+\f[B]apex\f[R](1), \f[B]apex\-plugins\f[R](7)
+.PP
+For complete documentation, see the \c
+.UR https://github.com/ttscoff/apex/wiki
+Apex Wiki
+.UE \c
+\&.
+.SH AUTHOR
+Brett Terpstra
+.SH COPYRIGHT
+Copyright (c) 2025 Brett Terpstra.
+Licensed under MIT License.
+.SH AUTHORS
+Brett Terpstra.