@simplrjs/markdown

@simplrjs/markdown

Creating markdown made easily.

Get started

$ npm install @simplrjs/markdown --save

Features

• Creating Markdown output

TODO

• Markdown file parser

Simple examples

Using MarkdownBuilder.

import * as fs from "fs-extra";
import { MarkdownBuilder } from "@simplrjs/markdown";

const builder = new MarkdownBuilder()
    .UnderlineHeader("Markdown Header", 1)
    .EmptyLine()
    .Text(md => `Hello ${md.Bold("World")}!`)
    .Text("It's so easy to print markdown this way!");

fs.writeFile("./text.md", builder.Build());

You can use MarkdownGenerator directly.

import * as fs from "fs-extra";
import { MarkdownGenerator } from "@simplrjs/markdown";

let output: string[] = [];

output = output.concat(MarkdownGenerator.UnderlineHeader("Markdown Header", 1));
output.push("");
output.push(`Hello ${MarkdownGenerator.Bold("World")}!`);

fs.writeFile("./text.md", output.join("\n"));

API

WIP

License

Released under the MIT license.