macro-md v1.4.3

macro-md

Table of Contents

• macro-md
  • Table of Contents
  • Description
  • Motivation
  • Installation
  • Example Usage
  • Use Cases
  • Syntax
    • Macro Parts:
    • Macro Formats:
    • Nested Macros
    • Inline vs Block Macros
  • API
    • Functions
    • Macro File Format
  • Issue Reporting
  • Links and References

Description

macro-md is a markdown post-processor that allows users to embed macros into a markdown document. These macros are simply JavaScript functions that are evaluated after the initial markdown compilation.

Motivation

Traditional markdown provides a way to rapidly create web content using a succinct and readable syntax. By design, authors are limited to only those HTML constructs that markdown is capable of producing.

macro-md seeks to extend the capabilities of vanilla markdown by providing a lightweight flexible text-transformation tool that is integrated with the markdown compilation process.

Macros may be embedded into the markdown using the provided syntax. The compiled markdown will then be passed to the macro:

Installation

macro-md is available as an npm package. To install, run:

npm install macro-md

Example Usage

Macro Definition

// macro.js
// Your macros go here.
export function wrap(content, wrapper) {
  return `${wrapper}${content}${wrapper}`;
}
wrap[MACRO_IDENTIFIER] = "wrap";

API Call

import { parseFile } from "macro-md";

// Path to your JavaScript macro file
const macroFilePath = "./macro.js";

// Example markdown with embedded macro
const markdown = `
This is some wrapped ^wrap(!){_inline_} content.

^wrap(!){

I'm wrapped **block** content

}`;

// macro-md API call
const html = await parseString(markdown, macroFilePath, {
  macroDelimiter: "~~",
  useGitHubStyleIds: true,
  useHighlightJS: true,
});

Result

<p>This is some wrapped !<em>inline</em>! content.</p>
!<p>I&#39;m wrapped <strong>block</strong> content</p>!

Use Cases

• ^insertDynamicStuff{} = insert some dynamic content
• ^C{...} = align the content center
• ^demo{...} = wrap the content in "demo" div
• ^+(my-class){...} = add a class to first html child node
• ^fig(src,alt,caption){...} = create a figure with caption.
• anything that can be done in JS!

Syntax

Macro Parts:

• macro delimiter
• identifier - name of the macro
• argument list (optional)
• content

Macro Formats:

• ^mac{ = macro with no args
• ^mac(a,b){ = macro with args
• ^mac1 mac2(80){ = space delineated list of macro calls, applied in innermost to outermost order; mac2 before mac1.

Spacing does not matter:

• ^mac(a,b){ == ^ mac( a,b ) {

Casing does matter.

• ^mac(a,b){ != ^Mac(a,b){

Nested Macros

Note: This feature works for simple scenarios, as in the below, but is quite buggy once nesting gets complex. It will require a major release to fix related issues.

Macros may be nested, allowing for modular design:

^macro1{ Do ^macro2{some} stuff. }

Inline vs Block Macros

macro-md is a markdown post-processor, so content supplied to the macros is HTML. The context of a macro determines whether the returned is treated as inline or block content. A Macro that is preceded and followed by a line break is a block level macro. Anything else is an inline macro.

API

Functions

macro-md defines two public entry points - the parseFile and parseString functions:

export async function parseFile(
  markdownPath: string,
  macroPath: string,
  options: Partial<MacroMDOptions> = defaultOptions
): Promise<string> {

export async function parseString(
  markdown: string,
  macroPath: string,
  options: Partial<MacroMDOptions> = defaultOptions
): Promise<string> {

Additional options may be specified in the MacroMDOptions object:

const defaultOptions: MacroMDOptions = {
  macroDelimiter: "^", // The character(s) that denote the start of a macro
  useGitHubStyleIds: false, // Whether to use GitHub style header ids
  useHighlightJS: false, // Whether to use highlight.js for code blocks
};

Macro File Format

• The macro file may be any file that can be loaded with the JavaScript's global import function.
• Functions that are to be used as macros must have a "macroIdentifier" property assigned to them. This serves as a link to the identifier for the macro. The user may use the exported MACRO_IDENTIFIER constant, or simply provide a string literal - we won't tell anyone ;)
• These functions must take a string as the first parameter. macro-md will always pass the content that is wrapped in curly braces into this argument. Whether to use this argument is up to the user.
• Additional arguments supplied to user defined macros are optional.

Issue Reporting

Issues may be reported on the GitHub Issues page.

Links and References

• Marked Demo. Not integrated with macro-md; included here for general markdown orientation.
• Marked Source. Source code for the excellent markdown parsing library.