@amanda-mitchell/remark-footer

There is a current proposal for a CommonMark extension for a footer element here: https://talk.commonmark.org/t/syntax-for-footer/2070

This package implements that proposal as a remark-parse plugin.

Installation

yarn add @amanda-mitchell/remark-footer

Use

Construct a unified parser and pass footers to it as a plugin:

const vfile = require('to-vfile');
const report = require('vfile-reporter');
const unified = require('unified');
const parse = require('remark-parse');
const { footers } = require('@amanda-mitchell/remark-footer');
const remark2rehype = require('remark-rehype');
const stringify = require('rehype-stringify');

const document = `^^ a footer`;

unified()
  .use(parse)
  .use(footers)
  .use(remark2rehype)
  .use(stringify)
  .process(vfile.readSync('example.md'), function (err, file) {
    console.error(report(err || file));
    console.log(String(file));
  });

When run, this script will print

<footer><p>A footer</p></footer>

Implementation notes

This package will work with either version 8 or 9 of remark-parse. However, the html generation is slightly different with version 9: footer text will always be wrapped in <p> tags, even when it would be reasonable to omit them. I'd be happy to accept a PR that improves this behavior!

Many remark-parse plugins also provide behavior to serialize an mdast syntax tree back to markdown. This plugin does not support this, but again, I'd be happy to accept a PR that adds the feature!