Sharkdown

An extendable Markdown parser.

Note

This is mostly meant as a hobby project. It is meant to be useful for me. Use it at your own risk.

How to use

Sharkdown syntax;

Parse a string of markdown text

parse(text: string, config: ParseConfiguration = defaultParseConfiguration): Document

Parses source code into a Sharkdown document.

Parameters

• text: string - The source code to parse.
• config: ParseConfiguration - Parse configuration.

Sample configuration:

const config: ParseConfiguration = {
    blocks: {
        // Parsers for custom blocks.
        parsers: [],
    },
    elements: {
        // Allowed custom elements.
        allowed: ["div", "aside", "section", "article", "header", "footer", "nav", "main", "figure", "figcaption"],
    },
    attributes: {
        // Allowed attributes on custom elements.
        allowed: ["style", /^data-.+/, /^aria-.+/],
    },
}

Example

#!/usr/bin/env node
import { readFile, writeFile } from "fs/promises";

import { parse, toHTML } from "@hansjovis/sharkdown";

async function generate() {
    const [ inFile, outFile ] = process.argv.slice(2);

    if (!inFile) {
        console.error("[ERROR] no source file defined");
        return;
    }

    const sourceCode = await readFile(inFile, "utf-8");
    
    const document = parse(sourceCode);
    const html = toHTML(document);

    await writeFile(outFile || "out.html", html);
}

generate();

How to develop

1. Clone this repository using Git.

   git clone ...
   

2. Install dependencies using NPM.

   npm install
   

3. Compile the source code.

   npm run compile
   

4. Run tests.

   npm test
   

5. Run parser on sample document.

   echo '# Hello world!' > test.md
   ./bin/parse-sharkdown.js test.md