tiny.zen.renderMarkdown

1/// Renders Markdown and returns an owner that must be deinitialized with the same allocator.2///3/// A heading may end in `{#exact.id}`. Explicit IDs are exact, case-sensitive,4/// page-wide unique, and omitted from the visible heading and contents label.5pub fn render(allocator: Allocator, source: []const u8, options: Options) Error!Rendered {6    const heading_plan = try planDiagnostic(source, options.diagnostic);7    try heading_plan.require(options.heading_limits);8    var document_storage = try document.Storage.init(allocator, heading_plan.exactLimits());9    errdefer document_storage.deinit(allocator);10    document_storage.activate();11    const doc = try inspectPlanned(&document_storage, source, heading_plan);12    errdefer document_storage.reset();13    const footnote_plan = try footnote.Plan.inspect(source, options.footnote_limits);14    var footnote_storage = try footnote.Storage.init(allocator, footnote_plan.exactLimits());15    defer footnote_storage.deinit(allocator);16    footnote_storage.activate();17    var footnotes = try footnote.parse(&footnote_storage, source);18    defer footnote_storage.reset();19    var out: std.ArrayList(u8) = .empty;20    errdefer out.deinit(allocator);21    const track_origins = options.link_report != null;22    var paragraph: InlineBuffer = .{ .track = track_origins };23    defer paragraph.deinit(allocator);24    var list_item: InlineBuffer = .{ .track = track_origins };25    defer list_item.deinit(allocator);26    var blockquote: InlineBuffer = .{ .track = track_origins };27    defer blockquote.deinit(allocator);28    var code_block: std.ArrayList(u8) = .empty;29    defer code_block.deinit(allocator);30    var math_block: std.ArrayList(u8) = .empty;31    defer math_block.deinit(allocator);32    var quiz_owner: QuizOwner = .{};33    defer quiz_owner.deinit(allocator);34    var table_storage: markdown_model.TableStorage = .{};35    var math_open = false;36    var cursor: usize = 0;37    var code_fence: ?Fence = null;38    var list_kind: ?ListKind = null;39    var semantic_list: ?SemanticList = null;40    var blockquote_open = false;41    var footnote_definition = false;42    var rendered_heading_index: usize = 0;43    var ego_stylesheet: ?EgoStylesheet = null;44    var deck = slides.Deck{ .options = options.slides };45    if (options.mode == .slides) try deck.begin(&out, allocator);4647    while (true) {48        const line_start = cursor;49        const raw_line = nextLine(source, &cursor) orelse break;50        const line = std.mem.trim(u8, raw_line, "\r");5152        if (code_fence) |fence| {53            if (closingFence(line, fence)) {54                try flushFence(55                    allocator,56                    &out,57                    fence,58                    code_block.items,59                    options,60                    doc,61                    &quiz_owner,62                    &ego_stylesheet,63                );64                code_block.clearRetainingCapacity();65                code_fence = null;66            } else {67                try code_block.appendSlice(allocator, line);68                try code_block.append(allocator, '\n');69            }70            continue;71        }7273        if (math_open) {74            const inner = std.mem.trim(u8, line, " \t");75            if (std.mem.eql(u8, inner, "$$")) {76                try flushDisplayMath(allocator, &out, &math_block, options.diagnostic);77                math_open = false;78            } else if (std.mem.endsWith(u8, inner, "$$")) {79                if (math_block.items.len != 0) try math_block.append(allocator, ' ');80                try math_block.appendSlice(allocator, std.mem.trimEnd(u8, inner[0 .. inner.len - 2], " \t"));81                try flushDisplayMath(allocator, &out, &math_block, options.diagnostic);82                math_open = false;83            } else if (inner.len != 0) {84                if (math_block.items.len != 0) try math_block.append(allocator, ' ');85                try math_block.appendSlice(allocator, inner);86            }87            continue;88        }8990        if (parseFence(line)) |fence| {91            if (semantic_list != null) return error.InvalidSemanticList;92            try flushParagraph(allocator, &out, &paragraph, &footnotes, options);93            try closeList(allocator, &out, &list_kind, &list_item, &footnotes, options);94            try closeBlockquote(allocator, &out, &blockquote_open, &blockquote, &footnotes, options);95            code_block.clearRetainingCapacity();96            var opened = fence;97            opened.source_offset = line_start;98            code_fence = opened;99            footnote_definition = false;100            continue;101        }102103        const trimmed = std.mem.trim(u8, line, " \t");104        if (parseSemanticList(trimmed)) |role| {105            try flushParagraph(allocator, &out, &paragraph, &footnotes, options);106            try closeList(107                allocator,108                &out,109                &list_kind,110                &list_item,111                &footnotes,112                options,113            );114            try closeBlockquote(115                allocator,116                &out,117                &blockquote_open,118                &blockquote,119                &footnotes,120                options,121            );122            if (semantic_list != null) return error.InvalidSemanticList;123            semantic_list = role;124            continue;125        }126        if (std.mem.startsWith(u8, trimmed, "$$")) {127            if (semantic_list != null) return error.InvalidSemanticList;128            try flushParagraph(allocator, &out, &paragraph, &footnotes, options);129            try closeList(allocator, &out, &list_kind, &list_item, &footnotes, options);130            try closeBlockquote(allocator, &out, &blockquote_open, &blockquote, &footnotes, options);131            footnote_definition = false;132            const rest = std.mem.trim(u8, trimmed[2..], " \t");133            if (rest.len >= 2 and std.mem.endsWith(u8, rest, "$$")) {134                try math_block.appendSlice(allocator, std.mem.trimEnd(u8, rest[0 .. rest.len - 2], " \t"));135                try flushDisplayMath(allocator, &out, &math_block, options.diagnostic);136            } else {137                math_open = true;138                try math_block.appendSlice(allocator, rest);139            }140            continue;141        }142        if (trimmed.len == 0) {143            try flushParagraph(allocator, &out, &paragraph, &footnotes, options);144            try closeList(allocator, &out, &list_kind, &list_item, &footnotes, options);145            try closeBlockquote(allocator, &out, &blockquote_open, &blockquote, &footnotes, options);146            footnote_definition = false;147            continue;148        }149150        const parsed_list_item = parseListItem(line);151        if (semantic_list != null and parsed_list_item == null) {152            return error.InvalidSemanticList;153        }154155        if (footnote.definition(line) != null) {156            try flushParagraph(allocator, &out, &paragraph, &footnotes, options);157            try closeList(allocator, &out, &list_kind, &list_item, &footnotes, options);158            try closeBlockquote(allocator, &out, &blockquote_open, &blockquote, &footnotes, options);159            footnote_definition = true;160            continue;161        }162        if (footnote_definition and footnote.continuation(line) != null) continue;163        footnote_definition = false;164165        const table_source = source[line_start..];166        switch (markdown_model.parseTable(&table_storage, table_source)) {167            .table => |table| {168                try flushParagraph(allocator, &out, &paragraph, &footnotes, options);169                try closeList(170                    allocator,171                    &out,172                    &list_kind,173                    &list_item,174                    &footnotes,175                    options,176                );177                try closeBlockquote(178                    allocator,179                    &out,180                    &blockquote_open,181                    &blockquote,182                    &footnotes,183                    options,184                );185                try appendTable(186                    allocator,187                    &out,188                    source,189                    table_source,190                    table,191                    &footnotes,192                    options,193                );194                cursor = line_start + table.source.end;195                continue;196            },197            .paragraph, .rejected => {},198        }199200        if (documentationArtifactBlock(trimmed)) {201            try flushParagraph(allocator, &out, &paragraph, &footnotes, options);202            try closeList(203                allocator,204                &out,205                &list_kind,206                &list_item,207                &footnotes,208                options,209            );210            try closeBlockquote(211                allocator,212                &out,213                &blockquote_open,214                &blockquote,215                &footnotes,216                options,217            );218            try appendInline(219                &out,220                allocator,221                trimmed,222                &footnotes,223                options.diagnostic,224                originWithin(source, trimmed),225                options.link_report,226            );227            try out.append(allocator, '\n');228            continue;229        }230231        if (parseBlockquote(line)) |quote| {232            try flushParagraph(allocator, &out, &paragraph, &footnotes, options);233            try closeList(allocator, &out, &list_kind, &list_item, &footnotes, options);234            if (!blockquote_open) blockquote_open = true;235            try blockquote.appendLine(allocator, source, quote);236            continue;237        }238        try closeBlockquote(allocator, &out, &blockquote_open, &blockquote, &footnotes, options);239240        if (parsed_list_item) |item| {241            try flushParagraph(allocator, &out, &paragraph, &footnotes, options);242            if (list_kind == null or list_kind.? != item.kind) {243                try closeList(allocator, &out, &list_kind, &list_item, &footnotes, options);244                try openList(allocator, &out, item.kind, semantic_list);245                semantic_list = null;246                list_kind = item.kind;247            }248            try flushListItem(allocator, &out, &list_item, &footnotes, options);249            try list_item.appendLine(allocator, source, item.text);250            continue;251        }252        if (list_kind != null) {253            if (listContinuation(line)) |continuation| {254                try list_item.appendLine(allocator, source, continuation);255                continue;256            }257        }258        try closeList(allocator, &out, &list_kind, &list_item, &footnotes, options);259260        if (try parseHeading(line, line_start, options.diagnostic)) |heading| {261            try flushParagraph(allocator, &out, &paragraph, &footnotes, options);262            std.debug.assert(rendered_heading_index < doc.headings.len);263            const inspected = doc.headings[rendered_heading_index];264            std.debug.assert(inspected.source_offset == line_start);265            std.debug.assert(std.mem.eql(u8, inspected.text, heading.text));266            rendered_heading_index += 1;267            try out.appendSlice(allocator, "<h");268            try appendDecimal(&out, allocator, heading.level);269            if (options.heading_anchors) {270                try out.appendSlice(allocator, " id=\"");271                try html.appendAttributeEscaped(&out, allocator, inspected.id);272                try out.append(allocator, '"');273            }274            try out.append(allocator, '>');275            try appendInline(276                &out,277                allocator,278                heading.text,279                &footnotes,280                options.diagnostic,281                originWithin(source, heading.text),282                options.link_report,283            );284            try out.appendSlice(allocator, "</h");285            try appendDecimal(&out, allocator, heading.level);286            try out.appendSlice(allocator, ">\n");287            continue;288        }289290        if (isThematicBreak(trimmed)) {291            try flushParagraph(allocator, &out, &paragraph, &footnotes, options);292            try closeList(allocator, &out, &list_kind, &list_item, &footnotes, options);293            try closeBlockquote(allocator, &out, &blockquote_open, &blockquote, &footnotes, options);294            if (options.mode == .slides) {295                try deck.split(&out, allocator);296                continue;297            }298            try out.appendSlice(allocator, "<hr>\n");299            continue;300        }301302        try paragraph.appendLine(allocator, source, trimmed);303    }304305    if (math_open) {306        if (options.diagnostic) |d| d.setEquation(math_block.items, .{307            .reason = "missing closing '$$'",308            .offset = math_block.items.len,309        });310        return error.InvalidEquation;311    }312    if (code_fence) |fence| try flushFence(313        allocator,314        &out,315        fence,316        code_block.items,317        options,318        doc,319        &quiz_owner,320        &ego_stylesheet,321    );322    if (semantic_list != null) return error.InvalidSemanticList;323    try flushParagraph(allocator, &out, &paragraph, &footnotes, options);324    try closeList(allocator, &out, &list_kind, &list_item, &footnotes, options);325    try closeBlockquote(allocator, &out, &blockquote_open, &blockquote, &footnotes, options);326    try appendFootnotes(allocator, &out, source, &footnotes, options);327    std.debug.assert(rendered_heading_index == doc.headings.len);328    if (options.mode == .slides) try deck.finish(&out, allocator);329330    return .{331        .html = try out.toOwnedSlice(allocator),332        .document = doc,333        .document_storage = document_storage,334    };335}

1/// Renders Markdown into an owned result; release it with the same allocator.2///3/// Malformed link targets return `InvalidInlineLink`. Inline input beyond4/// `max_markdown_inline_delimiters` or `max_markdown_inline_nesting` returns the5/// corresponding capacity error with source-local `Diagnostic` repair detail.6/// The nesting cap covers recursive links/emphasis, label brackets, and target7/// parentheses.8pub const renderMarkdown = markdown.render;