markdown 0.0.1-preview.1
CommonMark and GFM Markdown parser, AST, plugin system, and HTML renderer
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
1.0 KiB
Raw
/**
* Convenience bundle combining the built-in GFM extensions, GitHub alerts, and
* heading anchor slugs.
*/
import {GrowableArray} from 'zena:core';
import {MarkdownExtension} from '../plugin.zena';
import {strikethroughExtension} from './strikethrough.zena';
import {tablesExtension} from './tables.zena';
import {taskListExtension} from './task-list.zena';
import {autolinkExtension} from './autolink.zena';
import {alertsExtension} from './alerts.zena';
import {headingAnchorsExtension} from './heading-anchors.zena';
/**
* Returns the standard GFM extensions (pipe tables, strikethrough, task list
* items, and extended autolinks) plus GitHub alerts (`> [!NOTE]`, etc.).
*/
export function gfmExtensions(includeHeadingAnchors: boolean = false): GrowableArray<MarkdownExtension> {
let exts = new GrowableArray<MarkdownExtension>(6);
exts.push(tablesExtension());
exts.push(strikethroughExtension());
exts.push(taskListExtension());
exts.push(autolinkExtension());
exts.push(alertsExtension());
if (includeHeadingAnchors) {
exts.push(headingAnchorsExtension());
}
return exts;
}
| Version | Published | Dependencies | Approved by |
|---|---|---|---|
| 0.0.1-preview.1 | 2026-11-19 | none |
|