Skip to content

Latest commit

 

History

History
108 lines (70 loc) · 4.15 KB

README.md

File metadata and controls

108 lines (70 loc) · 4.15 KB
Raw

slimdown-js

A basic regex-based Markdown parser based on the gist by Johnny Broadway, converted from PHP to TypeScript, extended with several additional elements (images, tables, code blocks, underscores) and published to npm.

Inspired by:

Supports the following elements (and can be extended via addRule(regexp: RegExp, replacement: string | Function)):

  • Headers: # Header 1, or ## Header 2
  • Images: ![ALT TEXT](https://my_image_source)
  • Links: [ALT TEXT](https://my_image_source)
  • Bold: **bold** or __bold__
  • Emphasis: *italics* or _italics_
  • Deletions: ~~bold~~
  • Quotes: This is a quote: :"my quote":
  • Inline code: This is \inline` code`.
  • Code blocks: Use three subsequent backticks ` to open and close a code block.
  • Blockquotes: Lines starting with > .
  • Tables: Use pipes | to separate columns, and '-' to separate the table header from its body.
  • Underscores (Escape underscores to keep them \_)
  • Ordered/unordered lists (one level deep only)
  • Superscript and subscript (z~1~ or a^2^)

Size

The main reason for using this library, which hasn't been extensively tested and is not completely compatible with the spec, is to have something small. Version 0.7.0's size is 2.261 bytes uncompressed, and 1.241 bytes using 7z compression.

For more advanced scenario's, however, I can recommend marked, albeit at a bigger size: marked.min.js is 23.372 bytes uncompressed, and 7.684 bytes using gzip.

Playground

Head over to flems.io for a live example.

Development

Use npm start to convert the TypeScript code to JavaScript and npm test to run the test watcher. It uses microbundle to compile the final code to different output formats.

Usage

Here is the general use case:

import { render } from 'slimdown-js';

console.log(
  render('# Page title\n\nAnd **now** for something _completely_ different.',),
);

Adding rules

A simple rule to convert :) to an image:

import { render, addRule } from 'slimdown-js';

addRule ('/(\W)\:\)(\W)/', '$1<img src="smiley.png" />$2');

console.log(render(('Know what I\'m sayin? :)'));

In this example, we add GitHub-style internal linking (e.g., [[Another Page]]).

import { render, addRule } from 'slimdown-js';

const mywiki_internal_link = (title: string) =>
  `<a href="${title.replace(/[^a-zA-Z0-9_-]+/g, '_')}">${title}</a>`;

addRule('/[[(.*?)]]/e', mywiki_internal_link('$1'));

console.log(render('Check [[This Page]] out!'));

A longer example

import { render } from 'slimdown-js';

console.log(render(`# A longer example

And *now* [a link](http://www.google.com) to **follow** and [another](http://yahoo.com/).

* One
* Two
* Three

## Subhead

One **two** three **four** five.

One __two__ three _four_ five __six__ seven _eight_.

1. One
2. Two
3. Three

More text with `inline($code)` sample.

> A block quote
> across two lines.

More text...`));