https://github.com/ts-stack/markdown
A full-featured markdown parser and compiler, written in TypeScript.
https://github.com/ts-stack/markdown
gfm javascript markdown markdown-flavors markdown-parser typescript
Last synced: 6 months ago
JSON representation
A full-featured markdown parser and compiler, written in TypeScript.
- Host: GitHub
- URL: https://github.com/ts-stack/markdown
- Owner: ts-stack
- Created: 2017-12-10T01:40:37.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-08-26T00:25:19.000Z (about 2 years ago)
- Last Synced: 2025-03-28T16:11:09.506Z (6 months ago)
- Topics: gfm, javascript, markdown, markdown-flavors, markdown-parser, typescript
- Language: HTML
- Homepage:
- Size: 989 KB
- Stars: 142
- Watchers: 6
- Forks: 28
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# @ts-stack/markdown
> A full-featured markdown parser and compiler, written in TypeScript.
This is fork of popular library `marked` from [this commit](https://github.com/markedjs/marked/tree/39fbc8aed)
(Merge pull request #961 from chjj/release-0.3.7, Dec 1, 2017).
## lang
- [Chinese](./lang/zh/README.md)
## Table of contents
- [Install](#install)
- [Usage](#usage)
- [Minimal usage](#minimal-usage)
- [Example usage with highlight.js](#example-usage-with-highlightjs)
- [Overriding renderer methods](#overriding-renderer-methods)
- [Example of setting a simple block rule](#example-of-setting-a-simple-block-rule)
- [Benchmarks](#benchmarks)
- [Options for benchmarks](#options-for-benchmarks)
- [Example of usage bench options](#example-of-usage-bench-options)
- [Contribution and License Agreement](#contribution-and-license-agreement)
- [License](#license)
## Install
``` bash
npm install @ts-stack/markdown --save
```
## Usage
### Minimal usage:
```js
import { Marked } from '@ts-stack/markdown';
console.log(Marked.parse('I am using __markdown__.'));
// Outputs: I am using markdown.
```
Example setting options with default values:
```js
import { Marked, Renderer } from '@ts-stack/markdown';
Marked.setOptions ({
renderer: new Renderer,
gfm: true,
tables: true,
breaks: false,
pedantic: false,
sanitize: false,
smartLists: true,
smartypants: false
});
console.log(Marked.parse('I am using __markdown__.'));
```
### Example usage with highlight.js
```bash
npm install highlight.js --save
```
A function to highlight code blocks:
```ts
import { Marked } from '@ts-stack/markdown';
import hljs from 'highlight.js';
Marked.setOptions({ highlight: (code, lang) => hljs.highlight(lang, code).value });
let md = '```js\n console.log("hello"); \n```';
console.log(Marked.parse(md));
```
### Overriding renderer methods
The renderer option allows you to render tokens in a custom manner. Here is an
example of overriding the default heading token rendering by adding custom head id:
```ts
import { Marked, Renderer } from '@ts-stack/markdown';
class MyRenderer extends Renderer {
// Overriding parent method.
override heading(text: string, level: number, raw: string) {
const regexp = /\s*{([^}]+)}$/;
const execArr = regexp.exec(text);
let id: string;
if(execArr) {
text = text.replace(regexp, '');
id = execArr[1];
} else {
id = text.toLocaleLowerCase().replace(/[^\wа-яіїє]+/gi, '-');
}
return `${text}`;
}
}
Marked.setOptions({ renderer: new MyRenderer });
console.log(Marked.parse('# heading {my-custom-hash}'));
```
This code will output the following HTML:
```html
heading
```
### Example of setting a simple block rule
If you do not need recursiveness or checks some conditions before execute a regular expression, you can use the
`Marked.setBlockRule( regexp[, callback] )` method, which takes a regular expression as the first argument,
and returns result `regexp.exec(string)` to `callback(execArr)`, which can be passed as a second argument.
In regular expression very important adding symbol `^` from start. You should do this anyway.
```ts
import { Marked, escape } from '@ts-stack/markdown';
/**
* KaTeX is a fast, easy-to-use JavaScript library for TeX math rendering on the web.
*/
import * as katex from 'katex';
Marked.setBlockRule(/^@@@ *(\w+)\n([\s\S]+?)\n@@@/, function (execArr) {
// Don't use arrow function for this callback
// if you need Renderer's context, for example to `this.options`.
const channel = execArr[1];
const content = execArr[2];
switch(channel) {
case 'youtube': {
const id = escape(content);
return `\n\n`;
}
case 'katex': {
return katex.renderToString(escape(content));
}
default: {
const msg = `[Error: a channel "${channel}" for an embedded code is not recognized]`;
return '
' + msg + '';
}
}
});
const blockStr = `
# Example usage with embed block code
@@@ katex
c = \\pm\\sqrt{a^2 + b^2}
@@@
@@@ youtube
JgwnkM5WwWE
@@@
`;
const html = Marked.parse(blockStr);
console.log(html);
```
## Benchmarks
node v8.9.x
``` bash
git clone https://github.com/ts-stack/markdown.git
cd markdown
npm install
npm run bench
```
By default, these benchmarks run the entire markdown test suite once. The test suite includes every markdown feature,
it doesn't cater to specific aspects.
| Lib | Lib load, ms | Lib init, ms | Bench work, ms | Total, ms
| ------------------------|--------------|--------------|----------------|-----------
| @ts-stack/markdown v1.5.0 | 9 | 5 | 67 | 81
| marked v7.0.4 | 30 | 22 | 128 | 180
| markdown v0.5.0 | 10 | 8 | 180 | 198
| remarkable v2.0.1 | 22 | 9 | 126 | 157
| commonmark v0.30.0 | 51 | 2 | 120 | 173
| markdown-it v13.0.1 | 56 | 3 | 171 | 230
| showdown v2.1.0 | 18 | 38 | 545 | 601
### Options for benchmarks
```text
-l, --length Approximate string length in kilobytes. Default ~ 300 KB.
-t, --times Number of runs this bench. Default - 1 times.
```
Test files are accumulated in one file. If you specify, for example, `--length 100`
the first file will be taken, checked whether it is longer than 100 kilobytes,
and if no - it will be attached to the next one and checked its length, and so on.
#### Example of usage bench options
In order for npm passing the parameters, they need to be separated via ` -- `:
```text
npm run bench -- -l 500 -t 1
```
## Contribution and License Agreement
If you contribute code to this project, you are implicitly allowing your code
to be distributed under the MIT license. You are also implicitly verifying that
all code is your original work. ``
## Other libs from the author
If you enjoy working with TypeScript, we also recommend other libraries by the same author:
- [Ditsmod](https://ditsmod.github.io/en/) - a web framework for Node.js to build modular applications;
- [@ts-stack/openapi-spec](https://github.com/ts-stack/openapi-spec) - TypeScript models for writing OpenAPI documentation.