markdown 0.0.1-preview.1

CommonMark and GFM Markdown parser, AST, plugin system, and HTML renderer

Readme Files Dependencies Versions

Markdown (@zena-lang/markdown)#

A CommonMark and GitHub Flavored Markdown (GFM) parser, syntax tree, plugin system, and HTML renderer written in Zena (zena-lang:markdown/<library>). See docs/design/markdown.md for the design.

Usage#

Add it with zena pkg add zena-lang:markdown, then import its main library:

import {
  parse, renderHtml, markdownToHtml, gfmExtensions
} from 'zena-lang:markdown';

// Render CommonMark + GFM to safe HTML (raw HTML stripped, unsafe URLs blocked)
let html = markdownToHtml('# Hello\n\nSome ~~old~~ **new** text.', {
  extensions: gfmExtensions(),
  safe: true,
});

// Or parse to an AST first
let doc = parse('# Heading\n\nParagraph.', gfmExtensions());
let out = renderHtml(doc, {safe: true, extensions: gfmExtensions()});

Running Tests#

npm test -w @zena-lang/markdown
npm run test:quick -- packages/markdown/test
3.5 KiB Raw
/**
 * Heading anchor (`id` slug) generation and deduplication extension.
 */

import {GrowableArray, i32ToString} from 'zena:core';
import {StringBuilder, StringReader, asciiLowerByte, isAsciiAlpha, isAsciiDigit, isAsciiWhitespace} from 'zena:string';
import {HashMap} from 'zena:collections';
import {Block, Document, Heading, BlockQuote, ListBlock, ListItem, inlinesToPlainText} from '../ast.zena';
import {AstTransformer, BlockParserFactory, DelimiterProcessor, InlineContentParser, InlineParserRunner, MarkdownExtension, NodeRenderer} from '../plugin.zena';

final class HeadingAnchorsTransformer implements AstTransformer {
  #prefix: String;

  new(prefix: String) : #prefix = prefix;

  transform(doc: Document, inlineParser: InlineParserRunner): void {
    let counts = new HashMap<String, i32>();
    this.#visitBlocks(doc.blocks, counts);
  }

  #visitBlocks(blocks: GrowableArray<Block>, counts: HashMap<String, i32>): void {
    for (let block in blocks) {
      match (block) {
        case Heading as h: {
          if (h.id == null) {
            let text = inlinesToPlainText(h.inlines);
            let baseSlug = slugifyHeading(text);
            if (!baseSlug.isEmpty) {
              if (counts.has(baseSlug)) {
                let n = counts[baseSlug];
                counts[baseSlug] = n + 1;
                h.id = `${this.#prefix}${baseSlug}-${i32ToString(n)}`;
              } else {
                counts[baseSlug] = 1;
                h.id = `${this.#prefix}${baseSlug}`;
              };
            };
          };
        }
        case BlockQuote {blocks: let children}: {
          this.#visitBlocks(children, counts);
        }
        case ListBlock {items}: {
          for (let item in items) {
            this.#visitBlocks(item.blocks, counts);
          }
        }
        case ListItem {blocks: let children}: {
          this.#visitBlocks(children, counts);
        }
        case _: {}
      };
    }
  }
}

/**
 * Converts heading text to a lowercase URL slug, turning whitespace into `-`
 * and keeping ASCII letters, digits, `-`, `_`, and non-ASCII Unicode scalars.
 */
export function slugifyHeading(text: String): String {
  let trimmed = text.trim();
  let r = new StringReader(trimmed);
  let sb = new StringBuilder();
  var lastWrittenWasDash = false;
  var lastWasStrippedAfterDash = false;
  while (!r.isAtEnd) {
    let cp = r.advance();
    if (isAsciiAlpha(cp)
      || isAsciiDigit(cp)
      || cp == 0x5F
      || cp == 0x2D
      || cp >= 0x80) {
      sb.appendCodePoint(asciiLowerByte(cp));
      lastWrittenWasDash = cp == 0x2D;
      lastWasStrippedAfterDash = false;
    } else if (isAsciiWhitespace(cp)) {
      if (!lastWasStrippedAfterDash) {
        sb.appendByte(0x2D);
        lastWrittenWasDash = true;
      }
      lastWasStrippedAfterDash = false;
    } else if (lastWrittenWasDash) {
      lastWasStrippedAfterDash = true;
    }
  }
  return sb.toString();
}

/**
 * Returns the `MarkdownExtension` that populates deduplicated `id` slugs on
 * `Heading` AST nodes, each after `prefix`, which keeps them apart from the
 * IDs of the page the document is shown in (GitHub uses `user-content-`).
 */
export function headingAnchorsExtension(prefix: String = ''): MarkdownExtension {
  let transformers = new GrowableArray<AstTransformer>(1);
  transformers.push(new HeadingAnchorsTransformer(prefix));
  return new MarkdownExtension(
    new GrowableArray<BlockParserFactory>(0),
    new GrowableArray<DelimiterProcessor>(0),
    new GrowableArray<InlineContentParser>(0),
    transformers,
    new GrowableArray<NodeRenderer>(0)
  );
}
none
VersionPublishedDependenciesApproved by
0.0.1-preview.1 2026-11-19 none