https://github.com/simplrjs/markdown

https://github.com/simplrjs/markdown

markdown markdown-generator

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/simplrjs/markdown
• Owner: SimplrJS
• License: mit
• Created: 2017-08-06T12:24:53.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-02-27T18:29:45.000Z (about 3 years ago)
• Last Synced: 2025-10-02T04:54:58.778Z (6 months ago)
• Topics: markdown, markdown-generator
• Language: TypeScript
• Size: 207 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![NPM version](https://img.shields.io/npm/v/@simplrjs/markdown.svg?style=flat-square)](https://www.npmjs.com/package/@simplrjs/markdown)

[![Build](https://img.shields.io/travis/SimplrJS/markdown.svg?style=flat-square)](https://travis-ci.org/SimplrJS/markdown)

[![Coveralls](https://img.shields.io/coveralls/github/SimplrJS/markdown.svg?style=flat-square)](https://coveralls.io/github/SimplrJS/markdown)

[![Dependencies](https://img.shields.io/david/SimplrJS/markdown.svg?style=flat-square)](https://david-dm.org/simplrjs/markdown)

[![Dev Dependencies](https://img.shields.io/david/dev/SimplrJS/markdown.svg?style=flat-square)](https://david-dm.org/simplrjs/markdown?type=dev)

@simplrjs/markdown


Creating markdown made easily.

## Get started 

```sh

$ npm install @simplrjs/markdown --save

```

## Features

* Creating Markdown output

## TODO

* Markdown file parser

## Simple examples

Using `MarkdownBuilder`.

```typescript

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.

```typescript

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](LICENSE).