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
/**
* Public entry point for `markdown`: CommonMark and GFM parser, AST, plugin
* system, and HTML renderer.
*/
import {GrowableArray} from 'zena:core';
import {Document} from './ast.zena';
import {MarkdownExtension} from './plugin.zena';
import {parse} from './block-parser.zena';
import {HtmlRenderOptions, renderHtml} from './html.zena';
export * from './ast.zena';
export * from './plugin.zena';
export * from './block-parser.zena';
export * from './inline-parser.zena';
export * from './html.zena';
export * from './plugins/strikethrough.zena';
export * from './plugins/tables.zena';
export * from './plugins/task-list.zena';
export * from './plugins/autolink.zena';
export * from './plugins/alerts.zena';
export * from './plugins/heading-anchors.zena';
export * from './plugins/gfm.zena';
/**
* Parses `source` as Markdown and renders it directly to HTML.
*/
export function markdownToHtml(source: String, options: HtmlRenderOptions = {}): String {
let {extensions = new GrowableArray<MarkdownExtension>(
0
)} = options;
let doc = parse(source, extensions);
return renderHtml(doc, options);
}
| Version | Published | Dependencies | Approved by |
|---|---|---|---|
| 0.0.1-preview.1 | 2026-11-19 | none |
|