pugneum-linker

Link multiple pugneum ASTs together using include/extends

Installation

npm install pugneum-linker

Usage

var link = require('pugneum-linker');

link(ast, options)

Flatten the pugneum AST of inclusion and inheritance.

This function merely links the AST together. It doesn't read the file system to resolve and parse included and extended files. Thus, the main AST must already have the ASTs of the included and extended files embedded in the FileReference nodes. pugneum-loader is designed to do that.

options can contain the following properties:

• source (string): pugneum source code; used for error context
• maxLinkDepth (number): maximum template inheritance/include chain depth; default 256

The linker also resolves:

• Reference links/images — @[name] and ![name] nodes are resolved against a references block. Definitions can include optional default display text: name url Default Text.
• Footnotes — ^[name] nodes are resolved against a footnotes block. Three-pass architecture: collect definitions, resolve all references (including nested refs in definition content), then generate the <section role="doc-endnotes"> structure with numbered markers and DPUB-ARIA accessibility roles.
• Table of contents — toc nodes are replaced with a <nav role="doc-toc"> containing nested <ol> lists linking to headings with explicit id attributes.

License

MIT