marked-caml

A marked plugin to process caml -- Colon Attribute Markup Language.

Note that this plugin only parses the input -- it is up to you to handle and store metadata.

🕸 Weave a semantic web in your 🎋 WikiBonsai digital garden.

Install

Install with npm:

$ npm install marked-caml

Use

import { marked } from 'marked';
import camlExtension from 'marked-caml';

// Add the caml extension to marked
marked.use(camlExtension(options));

// Now parse markdown with caml attributes
const html = marked.parse(':caml::attributes\n');

Require style imports work as well:

const camlExtension = require('marked-caml');

// if you encounter issues, try:
const camlExtension = require('marked-caml').default;

Syntax

For syntax specifications, see the caml-spec repo.

Options

addAttr: (key: string, value: string) => void

Called once per collected caml attribute (key/value pair); use for metadata or indexing. A wiki-valued attribute is reported with the literal [[fname]] as the value — caml does not resolve wikirefs (a co-registered marked-wikirefs resolves the rendered value in a later pass; see the caml ⇄ wikirefs hand-off).

attrs

These are attrbox-specific options.

attrs.enable

A boolean property that toggles parsing and rendering wikiattrs on/off.

attrs.render

A boolean property that toggles rendering wikiattrs on/off. This is useful in the scenario where wikiattrs are used for metadata and not for display purposes; like a yaml-stand-in.

cssNames

CSS classnames may be overridden here.

cssNames.attr

Classname for wikiattrs. Default is attr.

cssNames.attrbox

Classname for the wikiattr attrbox. Default is attrbox.