• Stars
    star
    224
  • Rank 173,713 (Top 4 %)
  • Language
    HTML
  • License
    MIT License
  • Created almost 10 years ago
  • Updated almost 6 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A markdown (kramdown compatible) parser and compiler. Built for speed. (Fork of marked)

kramed

A full-featured markdown parser and compiler, written in JavaScript. Built for speed.

NPM version Build Status

Install

npm install kramed --save

Why fork marked ?

marked hasn't been evolving as much as it could be lately and due to our needs with GitBook, we need features such as robust mathjax support and want to strive closer to the rising kramdown standard.

Usage

Minimal usage:

var kramed = require('kramed');
console.log(kramed('I am using __markdown__.'));
// Outputs: <p>I am using <strong>markdown</strong>.</p>

Example setting options with default values:

var kramed = require('kramed');
kramed.setOptions({
  renderer: new kramed.Renderer(),
  gfm: true,
  tables: true,
  breaks: false,
  pedantic: false,
  sanitize: true,
  smartLists: true,
  smartypants: false
});

console.log(kramed('I am using __markdown__.'));

kramed(markdownString [,options] [,callback])

markdownString

Type: string

String of markdown source to be compiled.

options

Type: object

Hash of options. Can also be set using the kramed.setOptions method as seen above.

callback

Type: function

Function called when the markdownString has been fully parsed when using async highlighting. If the options argument is omitted, this can be used as the second argument.

Options

highlight

Type: function

A function to highlight code blocks. The first example below uses async highlighting with node-pygmentize-bundled, and the second is a synchronous example using highlight.js:

var kramed = require('kramed');

var markdownString = '```js\n console.log("hello"); \n```';

// Async highlighting with pygmentize-bundled
kramed.setOptions({
  highlight: function (code, lang, callback) {
    require('pygmentize-bundled')({ lang: lang, format: 'html' }, code, function (err, result) {
      callback(err, result.toString());
    });
  }
});

// Using async version of kramed
kramed(markdownString, function (err, content) {
  if (err) throw err;
  console.log(content);
});

// Synchronous highlighting with highlight.js
kramed.setOptions({
  highlight: function (code) {
    return require('highlight.js').highlightAuto(code).value;
  }
});

console.log(kramed(markdownString));

highlight arguments

code

Type: string

The section of code to pass to the highlighter.

lang

Type: string

The programming language specified in the code block.

callback

Type: function

The callback function to call when using an async highlighter.

renderer

Type: object Default: new Renderer()

An object containing functions to render tokens to HTML.

Overriding renderer methods

The renderer option allows you to render tokens in a custom manor. Here is an example of overriding the default heading token rendering by adding an embedded anchor tag like on GitHub:

var kramed = require('kramed');
var renderer = new kramed.Renderer();

renderer.heading = function (text, level) {
  var escapedText = text.toLowerCase().replace(/[^\w]+/g, '-');

  return '<h' + level + '><a name="' +
                escapedText +
                 '" class="anchor" href="#' +
                 escapedText +
                 '"><span class="header-link"></span></a>' +
                  text + '</h' + level + '>';
},

console.log(kramed('# heading+', { renderer: renderer }));

This code will output the following HTML:

<h1>
  <a name="heading-" class="anchor" href="#heading-">
    <span class="header-link"></span>
  </a>
  heading+
</h1>

Block level renderer methods

  • code(string code, string language)
  • blockquote(string quote)
  • html(string html)
  • heading(string text, number level)
  • hr()
  • list(string body, boolean ordered)
  • listitem(string text)
  • paragraph(string text)
  • table(string header, string body)
  • tablerow(string content)
  • tablecell(string content, object flags)

flags has the following properties:

{
    header: true || false,
    align: 'center' || 'left' || 'right'
}

Inline level renderer methods

  • strong(string text)
  • em(string text)
  • codespan(string code)
  • br()
  • del(string text)
  • link(string href, string title, string text)
  • image(string href, string title, string text)

gfm

Type: boolean Default: true

Enable GitHub flavored markdown.

tables

Type: boolean Default: true

Enable GFM tables. This option requires the gfm option to be true.

breaks

Type: boolean Default: false

Enable GFM line breaks. This option requires the gfm option to be true.

pedantic

Type: boolean Default: false

Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.

sanitize

Type: boolean Default: false

Sanitize the output. Ignore any HTML that has been input.

smartLists

Type: boolean Default: true

Use smarter list behavior than the original markdown. May eventually be default with the old behavior moved into pedantic.

smartypants

Type: boolean Default: false

Use "smart" typograhic punctuation for things like quotes and dashes.

Access to lexer and parser

You also have direct access to the lexer and parser if you so desire.

var tokens = kramed.lexer(text, options);
console.log(kramed.parser(tokens));
var lexer = new kramed.Lexer(options);
var tokens = lexer.lex(text);
console.log(tokens);
console.log(lexer.rules);

CLI

$ kramed -o hello.html
hello world
^D
$ cat hello.html
<p>hello world</p>

Philosophy behind kramed

The point of kramed was to create a markdown compiler where it was possible to frequently parse huge chunks of markdown without having to worry about caching the compiled output somehow...or blocking for an unnecesarily long time.

kramed is very concise and still implements all markdown features. It is also now fully compatible with the client-side.

kramed more or less passes the official markdown test suite in its entirety. This is important because a surprising number of markdown compilers cannot pass more than a few tests. It was very difficult to get kramed as compliant as it is. It could have cut corners in several areas for the sake of performance, but did not in order to be exactly what you expect in terms of a markdown rendering. In fact, this is why kramed could be considered at a disadvantage in the benchmarks above.

Along with implementing every markdown feature, kramed also implements GFM features.

Benchmarks

node v0.8.x

$ node test --bench
kramed completed in 3411ms.
kramed (gfm) completed in 3727ms.
kramed (pedantic) completed in 3201ms.
robotskirt completed in 808ms.
showdown (reuse converter) completed in 11954ms.
showdown (new converter) completed in 17774ms.
markdown-js completed in 17191ms.

Kramed is now faster than Discount, which is written in C.

For those feeling skeptical: These benchmarks run the entire markdown test suite 1000 times. The test suite tests every feature. It doesn't cater to specific aspects.

Pro level

You also have direct access to the lexer and parser if you so desire.

var tokens = kramed.lexer(text, options);
console.log(kramed.parser(tokens));
var lexer = new kramed.Lexer(options);
var tokens = lexer.lex(text);
console.log(tokens);
console.log(lexer.rules);
$ node
> require('kramed').lexer('> i am using kramed.')
[ { type: 'blockquote_start' },
  { type: 'paragraph',
    text: 'i am using kramed.' },
  { type: 'blockquote_end' },
  links: {} ]

Running Tests & Contributing

If you want to submit a pull request, make sure your changes pass the test suite. If you're adding a new feature, be sure to add your own test.

The kramed test suite is set up slightly strangely: test/new is for all tests that are not part of the original markdown.pl test suite (this is where your test should go if you make one). test/original is only for the original markdown.pl tests. test/tests houses both types of tests after they have been combined and moved/generated by running node test --fix or kramed --test --fix.

In other words, if you have a test to add, add it to test/new/ and then regenerate the tests with node test --fix. Commit the result. If your test uses a certain feature, for example, maybe it assumes GFM is not enabled, you can add .nogfm to the filename. So, my-test.text becomes my-test.nogfm.text. You can do this with any kramed option. Say you want line breaks and smartypants enabled, your filename should be: my-test.breaks.smartypants.text.

To run the tests:

cd kramed/
node test

TODO

  • Refactor code to have greater modularity
  • Strive for kramdown compatibility (it's the new standard)
  • Improve, improve, improve ...

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. </legalese>

License

Marked: Copyright (c) 2011-2014, Christopher Jeffrey. (MIT License) Kramed: Copyright (c) 2014, Aaron O'Mullan. (MIT Licensed)

See LICENSE for more info.

More Repositories

1

gitbook

The open source frontend for GitBook doc sites
TypeScript
26,513
star
2

javascript

GitBook teaching programming basics with Javascript
3,322
star
3

nuts

🌰 Releases/downloads server with auto-updater and GitHub as a backend
JavaScript
1,242
star
4

gitbook-cli

GitBook's command line interface
JavaScript
707
star
5

git

ProGit Book Fork generated using GitBook
306
star
6

markup-it

JavaScript library to parse and serialize markup content (Markdown and HTML)
JavaScript
268
star
7

markdown

Learn how to use Markdown
242
star
8

theme-default

Default theme for GitBook
JavaScript
195
star
9

rousseau

Lightweight proofreader in JS
JavaScript
179
star
10

theme-api

Theme for publishing a beautiful API documentation with GitBook
JavaScript
150
star
11

community

GitBook's official community page
107
star
12

gitbook-convert

CLI to convert an existing document to a GitBook.
JavaScript
101
star
13

slate-edit-table

Slate plugin for table edition
JavaScript
101
star
14

slate-edit-list

A Slate plugin to handle keyboard events in lists.
JavaScript
94
star
15

proxies-on-cloudflare

Proxies in Cloudflare Workers
TypeScript
93
star
16

plugin-mathjax

MathJAX plugin for GitBook
JavaScript
89
star
17

plugin-autocover

Generate a cover for the book
JavaScript
87
star
18

styleguide

GitBook.com HTML/CSS Style Guide
JavaScript
86
star
19

repofs

Simple and unified API to manipulate Git repositories
JavaScript
77
star
20

hunspell-spellchecker

Parse and use Hunspell dictionaries in Javascript
JavaScript
77
star
21

micro-analytics

A micro multi-website analytics database service designed to be fast and robust, built with Go and SQLite.
Go
76
star
22

plugin

Sample plugin for GitBook
JavaScript
66
star
23

integrations

Toolkit to build integrations on GitBook
TypeScript
62
star
24

filterable

Parse and convert GitHub-like search queries in Node.JS
JavaScript
61
star
25

example

Simple GitBook example
59
star
26

plugin-katex

Math typesetting using KaTex
JavaScript
59
star
27

plugin-exercises

Interactive exercices in a gitbook
JavaScript
56
star
28

react-rich-diff

React component to render rich diff between two documents (Markdown, HTML)
JavaScript
52
star
29

plugin-disqus

Disqus comments on your books
JavaScript
51
star
30

plugin-ga

Google Analytics tracking for your book
JavaScript
51
star
31

git-sync-normalization

A repository that shows how we translate every content block to markdown.
50
star
32

slate-edit-code

A Slate plugin for code block editing
JavaScript
43
star
33

theme-faq

Theme for publishing a FAQ or Knowledge base
HTML
38
star
34

node-gitbook-api

Node client library for the GitBook API
JavaScript
36
star
35

plugin-youtube

Plugin to insert youtube videos in a GitBook
JavaScript
33
star
36

tokenize-text

Javascript text tokenizer that is easy to use and compose.
JavaScript
30
star
37

slate-prism

A Slate plugin to highlight code blocks using PrismJS
JavaScript
27
star
38

plugin-quizzes

Interactive quizzes in a gitbook
JavaScript
26
star
39

plugin-search

Search content in your book
JavaScript
25
star
40

plugin-codetabs

Multiple languages code blocks for GitBook
JavaScript
25
star
41

plugin-algolia

Power search using Algolia
JavaScript
25
star
42

theme-official

GitBook theme for our own books
HTML
25
star
43

go-gitbook-api

GitBook API client in GO (golang)
Go
24
star
44

plugin-github

Display a link to your GitHub repo in your gitbook
JavaScript
24
star
45

slate-hyperprint

A library to convert Slate models to their slate-hyperscript representation
JavaScript
24
star
46

plugin-hints

GitBook plugin. Defines 4 types of styled hint blocks: info, danger, tip, working
JavaScript
23
star
47

expect-firestore

API client and Jasmine matchers for the Firestore Rules API
JavaScript
22
star
48

plugin-puml

UML Diagrams rendering using PlantUML
JavaScript
21
star
49

go-github-webhook

A GitHub webhook handler written in Go
Go
21
star
50

node-opds

Node.js library to parse/generate OPDS feed
JavaScript
21
star
51

plugin-comment

Inline discussions integrated with gitbook.com
JavaScript
20
star
52

node-onix

Node.JS library to parse/generate ONIX XML files
JavaScript
18
star
53

slate-sugar

🍭 Create Slate documents using JSX.
JavaScript
17
star
54

bipbip

Benchmark runner for performance regression test suites
JavaScript
17
star
55

slate-lite-renderer

Fast renderer for read-only Slate documents
JavaScript
16
star
56

plugin-fontsettings

Font settings for GitBook website
CSS
16
star
57

github-api-signature

Node.js signature generator for GitHub API using a PGP key
TypeScript
15
star
58

isbn-utils

Javascript utilities to parse and normalize ISBNs
JavaScript
15
star
59

plugin-versions

Display a <select> with other versions of your gitbook
JavaScript
15
star
60

markdown-css

Minimalist stylesheet (CSS or Less) for markup output
CSS
14
star
61

plugin-scripts

Include scripts in your GitBook
JavaScript
14
star
62

plugin-sharing

Sharing button in toolbar for GitBooks
JavaScript
14
star
63

tokenize-english

Javascript tokenizer for english sentences
JavaScript
14
star
64

diskache

Lightweight Golang disk cache
Go
13
star
65

mimedb

An extensive mime database in Go
Go
13
star
66

DraftMirror

Draft.js-like API on top of ProseMirror
JavaScript
13
star
67

normall

Normall: normalize filenames, accents etc ... in JS
JavaScript
13
star
68

plugin-highlight

Default syntax highlighter for GitBook
CSS
12
star
69

unstated

Simple state management for react
TypeScript
12
star
70

services-slack

Slack notifications service
JavaScript
12
star
71

plugin-gist

Embed Gist in your book
JavaScript
10
star
72

monorepo

A big home for small repos
Go
10
star
73

slate-edit-footnote

A Slate plugin to handle footnotes
JavaScript
10
star
74

lru-diskcache

A disk cache object that deletes the least-recently-used items
JavaScript
10
star
75

slate-edit-blockquote

A Slate plugin to handle keyboard events in blockquotes
JavaScript
10
star
76

plugin-styles-sass

SASS custom stylesheets instead of CSS
JavaScript
9
star
77

node-epubcheck

Node wrapper for epubcheck
JavaScript
9
star
78

plugin-lunr

Backend for the search plugin using Lunr
JavaScript
9
star
79

geo-utils

Utilities to get countries, languages and US states
JavaScript
9
star
80

slate-trailing-block

Slate plugin to ensure a trailing block
JavaScript
9
star
81

eslint-config-gitbook

GitBook's ESLint config, following our styleguide
JavaScript
9
star
82

go-sqlpool

A high level pool for maintaining pools of *sql.DB databases (e.g: thousands of SQLite files)
Go
9
star
83

syncgroup

Like golang's sync package but allows locking per groups of (string) keys (e.g: syncgroup.MutexGroup)
Go
9
star
84

public-docs

9
star
85

plugin-infinitescroll

Infinite scrolling in your gitbook
JavaScript
8
star
86

node-tasqueue

Node.js job/task-queue library using disque
JavaScript
8
star
87

plugin-livereload

Live reloading for your gitbook
JavaScript
8
star
88

plugin-tonic

Embed Tonic notebook into your GitBook
JavaScript
8
star
89

markdown-tools

A small CLI interface to kramed with lots of useful markdown tools (like go's "go fmt", lexing, rendering ...)
JavaScript
8
star
90

openapi-autodoc

Generate a GitBook Space from an OpenAPI spec
JavaScript
8
star
91

slate-no-empty

Slate plugin to prevent the document from being empty
JavaScript
8
star
92

plugin-mixpanel

Mixpanel tracking for your gitbook
JavaScript
7
star
93

brightml

Smart utility rendering markdown-ready HTML
JavaScript
7
star
94

html2hs

Convert HTML to hyperscript for virtual-dom
JavaScript
7
star
95

kramed-text-renderer

Renderer for kramed outputting plain text that can easily be fed to a search indexer/tokenizer/...
JavaScript
7
star
96

plugin-sitemap

Generate a sitemap for the gitbook website
JavaScript
7
star
97

firebase-apparatus

Lightweight implementation of firebase-tools as a Node module
TypeScript
7
star
98

licenses-utils

Utilities to detect licenses from project
JavaScript
7
star
99

example-visitor-authentication

Minimalist NodeJS application for "Visitor Authentication"
JavaScript
7
star
100

plugin-superscript

Use superscript in your content
JavaScript
6
star