Import Upstream version 0.7.0+~0.7.0
This commit is contained in:
zhouganqing
commit
5db7d81ac1
|
|
@ -0,0 +1,18 @@
|
|||
{
|
||||
"rules": {
|
||||
"indent": [2, "tab", {
|
||||
"MemberExpression": 0,
|
||||
"outerIIFEBody": 0
|
||||
}],
|
||||
"linebreak-style": [2, "unix"],
|
||||
"semi": [2, "always"],
|
||||
"no-console": 0,
|
||||
"no-unused-vars": ["error", { "args": "none" }]
|
||||
},
|
||||
"env": {
|
||||
"browser": true,
|
||||
"commonjs": true,
|
||||
"es6": true
|
||||
},
|
||||
"extends": "eslint:recommended"
|
||||
}
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
node_modules
|
||||
test/*/*.err
|
||||
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
0.1.4
|
||||
=====
|
||||
|
||||
* depends on marked 0.3.2
|
||||
* use .nf/.fi instead of .EX/.EE to format blockquotes
|
||||
|
||||
0.1.6
|
||||
=====
|
||||
|
||||
* ensure tests pass
|
||||
|
||||
0.2.0
|
||||
=====
|
||||
|
||||
* add support for gfm table
|
||||
|
||||
0.2.1
|
||||
=====
|
||||
|
||||
* remove useless test files from npm package
|
||||
|
||||
0.3.0
|
||||
=====
|
||||
|
||||
* accept a timestamp in milliseconds as --date argument
|
||||
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
Files:*
|
||||
Copyright: 2013 Jérémy Lal <kapouer@melix.org>
|
||||
License: MIT
|
||||
|
||||
Files: lib/marked-man.js
|
||||
Copyright: 2013 Jérémy Lal <kapouer@melix.org>
|
||||
2011-2013 Christopher Jeffrey (https://github.com/chjj/)
|
||||
License: MIT
|
||||
|
||||
Files: test/files/*
|
||||
Copyright: 2013 Jérémy Lal <kapouer@melix.org>
|
||||
2009 Ryan Tomayko (http://tomayko.com/about)
|
||||
License: MIT
|
||||
|
||||
License: MIT
|
||||
Permission is hereby granted, free of charge, to any person
|
||||
obtaining a copy of this software and associated documentation files
|
||||
(the "Software"), to deal in the Software without restriction,
|
||||
including without limitation the rights to use, copy, modify, merge,
|
||||
publish, distribute, sublicense, and/or sell copies of the Software,
|
||||
and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
.
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
.
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
|
||||
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
||||
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
man/marked-man.1: README.md
|
||||
./bin/marked-man -o $@ $<
|
||||
|
||||
doc: man/marked-man.1
|
||||
|
||||
check:
|
||||
node test/compare.js
|
||||
|
||||
|
|
@ -0,0 +1,91 @@
|
|||
[](https://nodei.co/npm/marked-man/)
|
||||
|
||||
marked-man(1) -- markdown to roff
|
||||
=================================
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
|
||||
```
|
||||
marked-man README.md > doc/marked-man.1
|
||||
```
|
||||
|
||||
See [marked README](https://github.com/chjj/marked) for documentation about how to use marked.
|
||||
|
||||
Note that `marked-man --format=html` is the same as `marked`.
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
`marked-man` wraps `marked` to extend it with groff output support in order to
|
||||
create Unix manual pages for use with `man`.
|
||||
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
|
||||
`marked-man` invokes `marked --gfm --sanitize`, and you can pass additional
|
||||
options through.
|
||||
The `--breaks` option, which retains intra-paragraph line breaks, can be helpful to match default ronn behavior.
|
||||
|
||||
`marked-man` adds some options to `marked`'s existing options:
|
||||
|
||||
* `--format <format>`
|
||||
Sets the output format. Outputs html if different from `roff`.
|
||||
Defaults to `roff`.
|
||||
|
||||
* `--name <name>`
|
||||
The name shown in the manpage header, if it isn't given in the ronn header like in this README.
|
||||
Defaults to empty string.
|
||||
|
||||
* `--section <section>`
|
||||
The section number shown in the manpage header, if it isn't given in the ronn header like in this README.
|
||||
Defaults to empty string.
|
||||
|
||||
* `--version <version>`
|
||||
The version shown in the manpage footer.
|
||||
Defaults to empty string.
|
||||
Breaking change in marked-man 0.7.0: this flag is converted to manVersion option,
|
||||
to avoid conflict with marked.
|
||||
|
||||
* `--manual <manual>`
|
||||
The manual-group name shown in the manpage header.
|
||||
Defaults to empty string.
|
||||
|
||||
* `--date <date>`
|
||||
The date shown in the manpage header.
|
||||
Defaults to now, must be acceptable to `new Date(string or timestamp)`.
|
||||
|
||||
|
||||
|
||||
INSTALLATION
|
||||
------------
|
||||
|
||||
From the [npm registry](https://npmjs.com):
|
||||
|
||||
* locally (`--save`, `--save-dev`, or `--save-optional` add `marked-man` to your `package.json` file as a runtime, development-time, or optional runtime dependency, respectively)
|
||||
|
||||
npm install marked-man [--save|--save-dev|--save-optional]
|
||||
|
||||
* globally (puts `marked-man` in your system's path):
|
||||
|
||||
[sudo] npm install marked-man -g
|
||||
|
||||
EXAMPLE
|
||||
-------
|
||||
|
||||
To view this README as a man page, run something like the following:
|
||||
|
||||
marked-man --version v0.1.0 --manual 'Man Utilities' README.md | man /dev/stdin
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
|
||||
[Ronn](https://github.com/rtomayko/ronn)
|
||||
|
||||
|
||||
REPORTING BUGS
|
||||
--------------
|
||||
|
||||
See [marked-man repository](https://github.com/kapouer/marked-man).
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
#!/usr/bin/env node
|
||||
|
||||
var marked = require('../');
|
||||
|
||||
process.argv = process.argv.map(function(tok) {
|
||||
return tok.replace(/^--version/, "--man-version");
|
||||
});
|
||||
|
||||
if (process.env.SOURCE_DATE_EPOCH) {
|
||||
marked.defaults.date = new Date(process.env.SOURCE_DATE_EPOCH * 1000).toISOString();
|
||||
}
|
||||
|
||||
var main = require('marked/bin/marked');
|
||||
|
||||
main(process.argv.slice(), function(err, code) {
|
||||
if (err) throw err;
|
||||
return process.exit(code || 0);
|
||||
});
|
||||
|
|
@ -0,0 +1,457 @@
|
|||
var marked = require('marked');
|
||||
|
||||
var InlineLexer = marked.InlineLexer;
|
||||
|
||||
var Parser = marked.Parser;
|
||||
|
||||
|
||||
InlineLexer.prototype.html_output = InlineLexer.prototype.output;
|
||||
InlineLexer.prototype.html_outputLink = InlineLexer.prototype.outputLink;
|
||||
|
||||
InlineLexer.prototype.roff_outputLink = function(cap, link) {
|
||||
var href = resc(link.href);
|
||||
var same = link.title == href;
|
||||
var text = '';
|
||||
if (same) text = '';
|
||||
else if (!link.title) text = this.output(cap[1]);
|
||||
if (text) text += ' ';
|
||||
return text
|
||||
+ '\\fI'
|
||||
+ href
|
||||
+ '\\fR';
|
||||
};
|
||||
|
||||
InlineLexer.prototype.roff_output = function(src) {
|
||||
var out = ''
|
||||
, link
|
||||
, text
|
||||
, cap
|
||||
, cur;
|
||||
|
||||
while (src) {
|
||||
// escape
|
||||
if ((cap = this.rules.escape.exec(src))) {
|
||||
src = src.substring(cap[0].length);
|
||||
out += lastMatch(cap);
|
||||
continue;
|
||||
}
|
||||
|
||||
// autolink
|
||||
if ((cap = this.rules.autolink.exec(src))) {
|
||||
src = src.substring(cap[0].length);
|
||||
if (cap[2] === '@') {
|
||||
text = cap[1][6] === ':'
|
||||
? cap[1].substring(7)
|
||||
: cap[1];
|
||||
} else {
|
||||
text = cap[1];
|
||||
}
|
||||
out += resc(text);
|
||||
continue;
|
||||
}
|
||||
|
||||
// url (gfm)
|
||||
if ((cap = this.rules.url.exec(src))) {
|
||||
src = src.substring(cap[0].length);
|
||||
out += resc(cap[0]);
|
||||
continue;
|
||||
}
|
||||
|
||||
// tag
|
||||
if ((cap = this.rules.tag.exec(src))) {
|
||||
src = src.substring(cap[0].length);
|
||||
out += resc(cap[0]);
|
||||
continue;
|
||||
}
|
||||
|
||||
// link
|
||||
if ((cap = this.rules.link.exec(src))) {
|
||||
src = src.substring(cap[0].length);
|
||||
out += this.outputLink(cap, {
|
||||
href: cap[2],
|
||||
title: cap[3]
|
||||
});
|
||||
continue;
|
||||
}
|
||||
|
||||
// reflink, nolink
|
||||
if ((cap = this.rules.reflink.exec(src))
|
||||
|| (cap = this.rules.nolink.exec(src))) {
|
||||
src = src.substring(cap[0].length);
|
||||
cur = lastMatch(cap).replace(/\s+/g, ' ');
|
||||
link = this.links[cur.toLowerCase()];
|
||||
|
||||
if (!link || !link.href) {
|
||||
out += cap[0][0];
|
||||
src = cap[0].substring(1) + src;
|
||||
continue;
|
||||
} else if (link.title) {
|
||||
out = out.slice(0, -cur.length);
|
||||
}
|
||||
out += this.outputLink(cap, link);
|
||||
continue;
|
||||
}
|
||||
|
||||
// strong
|
||||
if ((cap = this.rules.strong.exec(src))) {
|
||||
src = src.substring(cap[0].length);
|
||||
out += '\\fB'
|
||||
+ this.output(lastMatch(cap))
|
||||
+ '\\fR';
|
||||
continue;
|
||||
}
|
||||
|
||||
// em
|
||||
if ((cap = this.rules.em.exec(src))) {
|
||||
src = src.substring(cap[0].length);
|
||||
out += '\\fI'
|
||||
+ this.output(lastMatch(cap))
|
||||
+ '\\fR';
|
||||
continue;
|
||||
}
|
||||
|
||||
// code
|
||||
if ((cap = this.rules.code.exec(src))) {
|
||||
src = src.substring(cap[0].length);
|
||||
out += '\\fB'
|
||||
+ resc(lastMatch(cap), true)
|
||||
+ '\\fP';
|
||||
continue;
|
||||
}
|
||||
|
||||
// br
|
||||
if ((cap = this.rules.br.exec(src))) {
|
||||
src = src.substring(cap[0].length);
|
||||
out += '\n.br\n';
|
||||
continue;
|
||||
}
|
||||
|
||||
// del (gfm)
|
||||
if ((cap = this.rules.del.exec(src))) {
|
||||
src = src.substring(cap[0].length);
|
||||
out += "-"
|
||||
+ resc(lastMatch(cap))
|
||||
+ "-";
|
||||
continue;
|
||||
}
|
||||
|
||||
// text
|
||||
if ((cap = this.rules.text.exec(src))) {
|
||||
src = src.substring(cap[0].length);
|
||||
out += resc(cap[0]);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (src) {
|
||||
throw new Error('Infinite loop on byte: ' + src.charCodeAt(0));
|
||||
}
|
||||
}
|
||||
|
||||
return out;
|
||||
};
|
||||
|
||||
|
||||
Parser.prototype.parse = function(src) {
|
||||
this.inline = new InlineLexer(src.links, this.options);
|
||||
this.tokens = src.reverse();
|
||||
|
||||
if (this.options.format == "roff") {
|
||||
this.tok = this.roff_tok;
|
||||
this.inline.output = this.inline.roff_output;
|
||||
this.inline.outputLink = this.inline.roff_outputLink;
|
||||
var first = this.peek();
|
||||
if ((first.type != "heading" || first.depth != 1) && this.options.name) {
|
||||
this.tokens.push({type:"heading", depth:1});
|
||||
}
|
||||
} else {
|
||||
this.tok = this.html_tok;
|
||||
this.inline.output = this.inline.html_output;
|
||||
this.inline.outputLink = this.inline.html_outputLink;
|
||||
}
|
||||
|
||||
// NOTE marked.js Parser.tok() relies on a this.inlineText reference.
|
||||
this.inlineText = this.inline;
|
||||
|
||||
var out = '';
|
||||
while (this.next()) {
|
||||
out += this.tok();
|
||||
}
|
||||
|
||||
return out;
|
||||
};
|
||||
|
||||
|
||||
Parser.prototype.html_tok = Parser.prototype.tok;
|
||||
|
||||
Parser.prototype.isNestList = false;
|
||||
Parser.prototype.roff_tok = function() {
|
||||
var body;
|
||||
switch (this.token.type) {
|
||||
case 'space': {
|
||||
return '';
|
||||
}
|
||||
case 'hr': {
|
||||
return '.HR\n';
|
||||
}
|
||||
case 'heading': {
|
||||
var macro, text = this.token.text;
|
||||
if (this.token.depth == 1) {
|
||||
macro = 'TH';
|
||||
text = rparseHeader(text || "", this.options);
|
||||
} else if (this.token.depth == 2) {
|
||||
macro = 'SH';
|
||||
text = this.inline.output(text);
|
||||
} else {
|
||||
macro = 'SS';
|
||||
text = this.inline.output(text);
|
||||
}
|
||||
return '.'
|
||||
+ macro
|
||||
+ ' '
|
||||
+ text
|
||||
+ '\n';
|
||||
}
|
||||
case 'code': {
|
||||
if (this.options.highlight) {
|
||||
var code = this.options.highlight(this.token.text, this.token.lang);
|
||||
if (code != null && code !== this.token.text) {
|
||||
this.token.escaped = true;
|
||||
this.token.text = code;
|
||||
}
|
||||
}
|
||||
|
||||
if (!this.token.escaped) {
|
||||
this.token.text = resc(this.token.text);
|
||||
}
|
||||
|
||||
return '.P\n'
|
||||
+ '.RS 2\n'
|
||||
+ '.nf\n'
|
||||
+ this.token.text
|
||||
+ '\n.fi'
|
||||
+ '\n.RE\n';
|
||||
}
|
||||
case 'blockquote_start': {
|
||||
body = '';
|
||||
|
||||
while (this.next().type !== 'blockquote_end') {
|
||||
body += this.tok();
|
||||
}
|
||||
|
||||
return '.QP\n'
|
||||
+ body
|
||||
+ '\n.\n';
|
||||
}
|
||||
case 'list_start': {
|
||||
body = '';
|
||||
var order = this.token.ordered ? 1 : null;
|
||||
var originalLevel = this.isNestList;
|
||||
this.isNestList = true;
|
||||
while (this.next().type !== 'list_end') {
|
||||
if (order) this.token.order = order++;
|
||||
body += this.tok();
|
||||
}
|
||||
this.isNestList = originalLevel;
|
||||
|
||||
var indent = this.isNestList ? '.RS\n' : '.RS 0\n';
|
||||
return indent
|
||||
+ body
|
||||
+ '\n.RE\n';
|
||||
}
|
||||
case 'loose_item_start':
|
||||
case 'list_item_start': {
|
||||
body = '';
|
||||
var bullet = '\\(bu';
|
||||
var offset = 2;
|
||||
if (this.token.order) {
|
||||
bullet = this.token.order + '.';
|
||||
offset = 3;
|
||||
}
|
||||
while (this.next().type !== 'list_item_end') {
|
||||
var tok = this.tok();
|
||||
if (this.options.ronn && !this.options.breaks) {
|
||||
// replace first line that ends with colons
|
||||
tok = tok.replace(":\n", '\n.br\n');
|
||||
// replace dot + newline | whitespaces with dot + line break
|
||||
tok = tok.replace(/\.(?:\n|\s\s+)/g, ".\n.br\n");
|
||||
}
|
||||
body += tok;
|
||||
}
|
||||
|
||||
return '.IP '
|
||||
+ bullet
|
||||
+ ' '
|
||||
+ offset
|
||||
+ '\n'
|
||||
+ body;
|
||||
}
|
||||
case 'html': {
|
||||
return !this.token.pre && !this.options.pedantic
|
||||
? this.inline.output(this.token.text)
|
||||
: this.token.text;
|
||||
}
|
||||
case 'paragraph': {
|
||||
return '.P\n'
|
||||
+ this.inline.output(this.token.text)
|
||||
+ '\n';
|
||||
}
|
||||
case 'text': {
|
||||
return ''
|
||||
+ this.parseText()
|
||||
+ '\n';
|
||||
}
|
||||
|
||||
/* deal with table format, add by gholk.
|
||||
* use **tbl** macro format table in man page.
|
||||
*/
|
||||
case 'table': {
|
||||
var tblText = [], // troff tbl macro text.
|
||||
rowArray = []; // tmp array store cells in a table row.
|
||||
|
||||
tblText.push('.TS'); // table start
|
||||
|
||||
tblText.push('tab(|) expand nowarn box;');
|
||||
/* set `|` as seperator.
|
||||
*
|
||||
* set table border.
|
||||
*
|
||||
* set expand to full screen. without expand,
|
||||
* tbl sometimes mistake terminal width.
|
||||
* but expand is ugly sometimes...
|
||||
*
|
||||
* command need end by `;`.
|
||||
*/
|
||||
|
||||
var columnNumberRow = '';
|
||||
|
||||
for (var i=0; i<this.token.header.length; i++) {
|
||||
columnNumberRow += ' l';
|
||||
rowArray.push(
|
||||
'T{\n' +
|
||||
this.inline.output(this.token.header[i]) +
|
||||
'\nT}'
|
||||
);
|
||||
}
|
||||
columnNumberRow += '.';
|
||||
tblText.push(columnNumberRow);
|
||||
tblText.push(rowArray.join('|'));
|
||||
|
||||
tblText.push('_'); // add an horizantle line after header
|
||||
|
||||
|
||||
/* run each row */
|
||||
for (var j=0; j < this.token.cells.length; j++) {
|
||||
rowArray = []; // new array store cells in a row.
|
||||
var thisRow = this.token.cells[j]; // pointer to old array.
|
||||
|
||||
/* run each cell */
|
||||
for (var k=0; k < thisRow.length; k++)
|
||||
rowArray.push('T{\n' + this.inline.output(thisRow[k]) + '\nT}');
|
||||
|
||||
tblText.push(rowArray.join('|'));
|
||||
}
|
||||
|
||||
tblText.push('.TE');
|
||||
|
||||
return tblText.join('\n') + '\n';
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
function lastMatch(cap, exclude) {
|
||||
var len = cap.length;
|
||||
var cur;
|
||||
while (--len >= 0) {
|
||||
cur = cap[len];
|
||||
if (cur === exclude) continue;
|
||||
if (cur !== undefined) return cur;
|
||||
}
|
||||
}
|
||||
|
||||
function quote(str) {
|
||||
return '"' + str + '"';
|
||||
}
|
||||
|
||||
function resc(str) {
|
||||
if (str == null) return "";
|
||||
return rentities(str
|
||||
.replace(/\\/gm, "\\\\")
|
||||
.replace(/-/gm, "\\-")
|
||||
.replace(/^\./gm, "\\|.")
|
||||
.replace(/\./gm, "\\.")
|
||||
.replace(/^'/gm, "\\|'")).replace('&', '&');
|
||||
}
|
||||
|
||||
function rentities(str) {
|
||||
return str.replace(/&(\w+);/gm, function(match, ent) {
|
||||
var gr = {
|
||||
bull: '[ci]',
|
||||
nbsp: '~',
|
||||
copy: '(co',
|
||||
rdquo: '(rs',
|
||||
mdash: '(em',
|
||||
reg: '(rg',
|
||||
sect: '(sc',
|
||||
ge: '(>=',
|
||||
le: '(<=',
|
||||
ne: '(!=',
|
||||
equiv: '(==',
|
||||
plusmn: '(+-'
|
||||
}[ent];
|
||||
if (gr) return '\\' + gr;
|
||||
else return match;
|
||||
});
|
||||
}
|
||||
|
||||
function rparseHeader(str, options) {
|
||||
var match = /^([\w_.[\]~+=@:-]+)\s*(?:\((\d\w*)\))?(?:\s*-+\s*(.*))?/.exec(str);
|
||||
var name, section, text;
|
||||
if (match) {
|
||||
name = match[1];
|
||||
section = match[2];
|
||||
text = match[3];
|
||||
}
|
||||
|
||||
if (!name) name = options.name || "";
|
||||
if (!section) section = options.section || "";
|
||||
if (!text) {
|
||||
if (name || section) text = "";
|
||||
else text = str;
|
||||
}
|
||||
if (name && text) text = " - " + text;
|
||||
|
||||
return quote(resc(name.toUpperCase()))
|
||||
+ " "
|
||||
+ quote(section)
|
||||
+ " "
|
||||
+ quote(manDate(options.date))
|
||||
+ " "
|
||||
+ quote(options.manVersion)
|
||||
+ " "
|
||||
+ quote(options.manual)
|
||||
+ "\n.SH "
|
||||
+ quote("NAME")
|
||||
+ "\n\\fB"
|
||||
+ name
|
||||
+ "\\fR"
|
||||
+ resc(text);
|
||||
}
|
||||
function manDate(date) {
|
||||
var stamp = parseInt(date);
|
||||
if (!isNaN(stamp) && stamp.toString().length == date.length) date = stamp;
|
||||
date = new Date(date);
|
||||
var month = ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"][date.getMonth()];
|
||||
return month + " " + date.getFullYear();
|
||||
}
|
||||
|
||||
marked.defaults.format = "roff";
|
||||
marked.defaults.name = "";
|
||||
if (marked.defaults.date == null) marked.defaults.date = new Date;
|
||||
marked.defaults.section = "";
|
||||
marked.defaults.manVersion = "";
|
||||
marked.defaults.manual = "";
|
||||
marked.defaults.gfm = true;
|
||||
marked.defaults.breaks = false;
|
||||
marked.defaults.ronn = false;
|
||||
|
||||
module.exports = marked;
|
||||
|
|
@ -0,0 +1,56 @@
|
|||
.TH "MARKED\-MAN" "1" "January 2014" "" ""
|
||||
.SH "NAME"
|
||||
\fBmarked-man\fR \- markdown to roff
|
||||
.SH SYNOPSIS
|
||||
.P
|
||||
.RS 2
|
||||
.EX
|
||||
marked\-man README\.md > doc/marked\-man\.1
|
||||
.EE
|
||||
.RE
|
||||
.P
|
||||
See marked README \fIhttps://github\.com/chjj/marked\fR for documentation about how to use marked\.
|
||||
.P
|
||||
Note that \fBmarked\-man \-\-format=html\fR is the same as \fBmarked\fR\|\.
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
\fBmarked\-man\fR wraps \fBmarked\fR to extend it with groff output support\.
|
||||
.SH OPTIONS
|
||||
.P
|
||||
\fBmarked\-man\fR adds some options to \fBmarked\fR existing options:
|
||||
.RS 0
|
||||
.IP \(bu 2
|
||||
format
|
||||
Sets the output format\. Outputs html if different from \fBroff\fR\|\.
|
||||
Defaults to \fBroff\fR\|\.
|
||||
.IP \(bu 2
|
||||
name
|
||||
The name shown in the manpage header, if it isn\'t given in the ronn header like in this README\.
|
||||
Defaults to empty string\.
|
||||
.IP \(bu 2
|
||||
section
|
||||
The section shown in the manpage header, if it isn\'t given in the ronn header like in this README\.
|
||||
Defaults to empty string\.
|
||||
.IP \(bu 2
|
||||
version
|
||||
The version shown in the manpage header\.
|
||||
Defaults to empty string\.
|
||||
.IP \(bu 2
|
||||
manual
|
||||
The MANUAL string shown in the manpage header\.
|
||||
Defaults to empty string\.
|
||||
.IP \(bu 2
|
||||
date
|
||||
The date shown in the manpage header\.
|
||||
Defaults to now, must be acceptable by new Date(string)\.
|
||||
|
||||
.RE
|
||||
.P
|
||||
\fBmarked\-man\fR invokes \fBmarked \-\-gfm \-\-sanitize\fR\|\.
|
||||
The \-\-breaks option can be helpful to match default \fBronn\fR behavior\.
|
||||
.SH SEE ALSO
|
||||
.P
|
||||
Ryan Tomayko \fIhttps://github\.com/rtomayko/ronn\fR
|
||||
.SH REPORTING BUGS
|
||||
.P
|
||||
See marked\-man repository \fIhttps://github\.com/kapouer/marked\-man\fR\|\.
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
root = true
|
||||
|
||||
[*.{json,js}]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
insert_final_newline = true
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
|
||||
[*.md, !test/*.md]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
indent_style = tab
|
||||
indent_size = 4
|
||||
|
|
@ -0,0 +1 @@
|
|||
*.min.js
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
{
|
||||
"extends": "standard",
|
||||
"plugins": [
|
||||
"standard"
|
||||
],
|
||||
"parserOptions": {
|
||||
"ecmaVersion": 5,
|
||||
"sourceType": "script"
|
||||
},
|
||||
"rules": {
|
||||
"semi": ["error", "always"],
|
||||
"indent": ["error", 2, {
|
||||
"SwitchCase": 1,
|
||||
"VariableDeclarator": { "var": 2 },
|
||||
"outerIIFEBody": 0
|
||||
}],
|
||||
"operator-linebreak": ["error", "before", { "overrides": { "=": "after" } }],
|
||||
"space-before-function-paren": ["error", "never"],
|
||||
"no-cond-assign": "off",
|
||||
"no-useless-escape": "off",
|
||||
"one-var": "off",
|
||||
"no-control-regex": "off"
|
||||
},
|
||||
"env": {
|
||||
"node": true,
|
||||
"browser": true,
|
||||
"amd": true
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
test/* linguist-vendored
|
||||
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
**Marked version:**
|
||||
|
||||
**Markdown flavor:** Markdown.pl|CommonMark|GitHub Flavored Markdown|n/a
|
||||
|
||||
<!-- The NPM version or commit hash having the issue -->
|
||||
|
||||
<!--
|
||||
|
||||
If submitting something other than a defect with Marked itself, please use the following:
|
||||
|
||||
**Proposal type:** new feature | project operations | other
|
||||
|
||||
## What pain point are you perceiving?
|
||||
|
||||
## What solution are you suggesting?
|
||||
|
||||
-->
|
||||
|
||||
## Expectation
|
||||
|
||||
**CommonMark Demo:** [demo](https://spec.commonmark.org/dingus/)
|
||||
<!-- You can replace the link above with a permalink from: https://spec.commonmark.org/dingus/ -->
|
||||
|
||||
<!-- Describe the output you are expecting from marked -->
|
||||
|
||||
## Result
|
||||
|
||||
**Marked Demo:** [demo](https://marked.js.org/demo/)
|
||||
<!-- You can replace the link above with a permalink from: https://marked.js.org/demo/ -->
|
||||
|
||||
<!-- Describe the output you received from marked -->
|
||||
|
||||
## What was attempted
|
||||
|
||||
<!-- Describe what code combination got you there -->
|
||||
|
||||
<!--
|
||||
If error is thrown add the following:
|
||||
|
||||
## Call stack & console log
|
||||
|
||||
-->
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Marked says it does this thing but does not
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
|
||||
<!-- If possible, use the Marked Demo permalink and compare to the CommonMark Dingus permalink to demonstrate the bug -->
|
||||
<!--
|
||||
1. [Marked Demo](https://marked.js.org/demo/)
|
||||
2. [CommonMark Demo](https://spec.commonmark.org/dingus/)
|
||||
-->
|
||||
|
||||
<!-- If you need a specific version and options to reproduce the bug, use the following template -->
|
||||
<!--
|
||||
1. Install marked `npm install --save marked@0.3.19` with the version you are using
|
||||
2. Run marked with input string and options such as `marked('hello *world*', {gfm: true})`
|
||||
3. Actual output (or error) is...
|
||||
-->
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: Marked doesn't do this thing and I think it should
|
||||
|
||||
---
|
||||
|
||||
**Describe the feature**
|
||||
A clear and concise description of what you would like.
|
||||
|
||||
**Why is this feature necessary?**
|
||||
A clear and concise description of why.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
name: Proposal
|
||||
about: Marked doesn't do this thing and I think it should
|
||||
|
||||
---
|
||||
|
||||
**What pain point are you perceiving?.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
|
@ -0,0 +1,53 @@
|
|||
|
||||
<!--
|
||||
|
||||
If release PR, add ?template=release.md to the PR url to use the release PR template.
|
||||
|
||||
If badging PR, add ?template=badges.md to the PR url to use the badges PR template.
|
||||
|
||||
Otherwise, you are stating this PR fixes an issue that has been submitted; or,
|
||||
describes the issue or proposal under consideration and contains the project-related code to implement.
|
||||
|
||||
-->
|
||||
|
||||
**Marked version:**
|
||||
|
||||
<!-- The NPM version or commit hash having the issue -->
|
||||
|
||||
**Markdown flavor:** Markdown.pl|CommonMark|GitHub Flavored Markdown|n/a
|
||||
|
||||
## Description
|
||||
|
||||
- Fixes #### (if fixing a known issue; otherwise, describe issue using the following format)
|
||||
|
||||
<!--
|
||||
|
||||
If no issue exists that you're aware of. The maintainers should be able to figure out if it's a duplicate.
|
||||
|
||||
## Expectation
|
||||
|
||||
Describe the output you are expecting from marked
|
||||
|
||||
## Result
|
||||
|
||||
Describe the output you received from marked
|
||||
|
||||
## What was attempted
|
||||
|
||||
Describe what code combination got you there
|
||||
|
||||
-->
|
||||
|
||||
## Contributor
|
||||
|
||||
- [ ] Test(s) exist to ensure functionality and minimize regression (if no tests added, list tests covering this PR); or,
|
||||
- [ ] no tests required for this PR.
|
||||
- [ ] If submitting new feature, it has been documented in the appropriate places.
|
||||
|
||||
## Committer
|
||||
|
||||
In most cases, this should be a different person than the contributor.
|
||||
|
||||
- [ ] Draft GitHub release notes have been updated.
|
||||
- [ ] CI is green (no forced merge required).
|
||||
- [ ] Merge PR
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
**@mention the contributor:**
|
||||
|
||||
## Recommendation to:
|
||||
|
||||
- [ ] Change user group
|
||||
- [ ] Add a badge
|
||||
- [ ] Remove a badge
|
||||
|
||||
<!--
|
||||
|
||||
Explain your reasoning behind tagging that person.
|
||||
|
||||
Preferably by citing objective examples, like PRs, Issues, and so on.
|
||||
|
||||
-->
|
||||
|
||||
## As the one mentioned, I would like to:
|
||||
|
||||
- [ ] accept the recommendation; or,
|
||||
- [ ] graciously decline; or,
|
||||
- [ ] dispute the recommendation
|
||||
|
||||
within 30 days, if you have not indicated which option you are taking one of the following will happen:
|
||||
|
||||
1. If adding a badge, we will assume you are graciously declining.
|
||||
2. If removing a badge, we will assume you do not want to dispute the recommendation; therefore, the badge will be removed.
|
||||
|
||||
<!--
|
||||
|
||||
Why would someone not accept a badge? Loads of reasons depending on the circumstances.
|
||||
|
||||
1. If you're a committer and someone puts a badge for you on having decision making authority in an area, do you really a) think you earned it and b) think you can do that *and* all the other stuff you got going as a committer, admin, or publisher (not to even mention your outside life)? Maybe not. And that's okay. Thank them for the recognition, explain you aren't able to take more on at the moment. It's cool to get recognized though.
|
||||
2. Maybe you don't feel you actually earned it yet. I remember being in an interview once. The interviewer asked me to give an example of going above and beyond the call of duty. I said, "That's hard. Because what you consider going above and beyond may be what I consider to be 'just rising to'. If we're in battle and you get wounded and I pull you out of the frey before heading back into it, I don't consider that going above and beyond; I consider that rising to."
|
||||
|
||||
Why would someone remove their own badge? Loads of reasons...
|
||||
|
||||
1. Maybe you got a lot going on right now and want to broadcast to the Marked community that, "Hey, I don't want to say I'm going to do this unless I can really commit to it right now in a way that serves the project well." That's awesome! That takes courage! Because a) saying "no" is hard for most humans ("people pleasers") and b) the alternative, well, for those of us here since about October of 2017 (and prior), we know what the alternative can look like.
|
||||
2. Maybe you just think you've done all you can to help and learned all you can from the experience. Again, very awesome and courageous. It takes courage to know when to walk away on your own accord.
|
||||
|
||||
Why would you want to remove someone's badge? Loads of reasons...
|
||||
|
||||
1. Maybe they have decision making authority on something. You asked for their advice. And, you ended up waiting almost a month before receiving a response.
|
||||
2. Maybe it was relevant at the time (Master of Marked, for example) but you think they've lost their former level of skill (fell out of practice, for example). They could always get it back.
|
||||
3. Maybe to signal to them that, "Hey, you seem to have forgotten about us. Are you still around (or alive)?"
|
||||
|
||||
Anyway, you get the idea. This isn't about good or bad...it's just about giving the community a simple game mechanic by which to publicly say, "Thank you" or "Here's what my status is" in the community or "Hey, I think something's wrong here" in a civil manner.
|
||||
|
||||
-->
|
||||
|
||||
Note: All committers must approve via review before merging, the disapproving committer can simply close the PR.
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
## Publisher
|
||||
|
||||
- [ ] `$ npm version` has been run.
|
||||
- [ ] Release notes in [draft GitHub release](https://github.com/markedjs/marked/releases) are up to date
|
||||
- [ ] Release notes include which flavors and versions of Markdown are supported by this release
|
||||
- [ ] Committer checklist is complete.
|
||||
- [ ] Merge PR.
|
||||
- [ ] Publish GitHub release using `master` with correct version number.
|
||||
- [ ] `$ npm publish` has been run.
|
||||
- [ ] Create draft GitHub release to prepare next release.
|
||||
|
||||
Note: If merges to `master` occur after submitting this PR and before running `$ npm pubish` you should be able to
|
||||
|
||||
1. pull from `upstream/master` (`git pull upstream master`) into the branch holding this version,
|
||||
2. run `$ npm run build` to regenerate the `min` file, and
|
||||
3. commit and push the updated changes.
|
||||
|
||||
## Committer
|
||||
|
||||
In most cases, this should be someone different than the publisher.
|
||||
|
||||
- [ ] Version in `package.json` has been updated (see [PUBLISHING.md](https://github.com/markedjs/marked/blob/master/docs/PUBLISHING.md)).
|
||||
- [ ] The `marked.min.js` has been updated; or,
|
||||
- [ ] release does not change library.
|
||||
- [ ] CI is green (no forced merge required).
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
.DS_Store
|
||||
node_modules/
|
||||
test/compiled_tests
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
language: node_js
|
||||
|
||||
jobs:
|
||||
fast_finish: true
|
||||
allow_failures:
|
||||
- stage: security scan 🔐
|
||||
|
||||
include:
|
||||
- stage: unit tests 👩🏽💻
|
||||
script: npm run test:unit
|
||||
node_js: lts/*
|
||||
|
||||
- stage: spec tests 👩🏽💻
|
||||
script: npm run test:specs
|
||||
node_js: v4
|
||||
- node_js: lts/*
|
||||
- node_js: node
|
||||
|
||||
- stage: lint ✨
|
||||
script: npm run test:lint
|
||||
node_js: lts/*
|
||||
|
||||
- stage: minify 🗜️
|
||||
script: |
|
||||
npm run build
|
||||
if ! git diff --quiet; then
|
||||
git config --global user.email "travis@travis-ci.org"
|
||||
git config --global user.name "Travis-CI"
|
||||
git config credential.helper "store --file=.git/credentials"
|
||||
echo "https://${GITHUB_TOKEN}:@github.com" > .git/credentials
|
||||
git commit -am '🗜️ minify [skip ci]'
|
||||
git push origin HEAD:${TRAVIS_BRANCH}
|
||||
fi
|
||||
node_js: lts/*
|
||||
if: branch = master AND type = push
|
||||
|
||||
- stage: security scan 🔐
|
||||
script: npm run test:redos
|
||||
node_js: lts/*
|
||||
|
||||
cache:
|
||||
directories:
|
||||
- node_modules
|
||||
|
||||
git:
|
||||
depth: 3
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
# License information
|
||||
|
||||
## Contribution 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>`
|
||||
|
||||
## Marked
|
||||
|
||||
Copyright (c) 2011-2018, Christopher Jeffrey (https://github.com/chjj/)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
## Markdown
|
||||
|
||||
Copyright © 2004, John Gruber
|
||||
http://daringfireball.net/
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||||
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
||||
* Neither the name “Markdown” nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
||||
|
||||
This software is provided by the copyright holders and contributors “as is” and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright owner or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
all:
|
||||
@cp lib/marked.js marked.js
|
||||
@uglifyjs --comments '/\*[^\0]+?Copyright[^\0]+?\*/' -o marked.min.js lib/marked.js
|
||||
|
||||
clean:
|
||||
@rm marked.js
|
||||
@rm marked.min.js
|
||||
|
||||
bench:
|
||||
@node test --bench
|
||||
|
||||
man/marked.1.txt:
|
||||
groff -man -Tascii man/marked.1 | col -b > man/marked.1.txt
|
||||
|
||||
.PHONY: clean all
|
||||
|
|
@ -0,0 +1,76 @@
|
|||
<a href="https://marked.js.org">
|
||||
<img width="60px" height="60px" src="https://marked.js.org/img/logo-black.svg" align="right" />
|
||||
</a>
|
||||
|
||||
# Marked
|
||||
|
||||
[](https://www.npmjs.com/package/marked)
|
||||
[](https://cdn.jsdelivr.net/npm/marked/marked.min.js)
|
||||
[](https://packagephobia.now.sh/result?p=marked)
|
||||
[](https://www.npmjs.com/package/marked)
|
||||
[](https://david-dm.org/markedjs/marked)
|
||||
[](https://david-dm.org/markedjs/marked?type=dev)
|
||||
[](https://travis-ci.org/markedjs/marked)
|
||||
[](https://snyk.io/test/npm/marked)
|
||||
|
||||
- ⚡ built for speed
|
||||
- ⬇️ low-level compiler for parsing markdown without caching or blocking for long periods of time
|
||||
- ⚖️ light-weight while implementing all markdown features from the supported flavors & specifications
|
||||
- 🌐 works in a browser, on a server, or from a command line interface (CLI)
|
||||
|
||||
## Demo
|
||||
|
||||
Checkout the [demo page](https://marked.js.org/demo/) to see marked in action ⛹️
|
||||
|
||||
## Docs
|
||||
|
||||
Our [documentation pages](https://marked.js.org) are also rendered using marked 💯
|
||||
|
||||
Also read about:
|
||||
|
||||
* [Options](https://marked.js.org/#/USING_ADVANCED.md)
|
||||
* [Extensibility](https://marked.js.org/#/USING_PRO.md)
|
||||
|
||||
## Installation
|
||||
|
||||
**CLI:** `npm install -g marked`
|
||||
|
||||
**In-browser:** `npm install marked`
|
||||
|
||||
## Usage
|
||||
|
||||
### Warning: 🚨 Marked does not [sanitize](https://marked.js.org/#/USING_ADVANCED.md#options) the output HTML. Please use a sanitize library, like [DOMPurify](https://github.com/cure53/DOMPurify) (recommended), [sanitize-html](https://github.com/apostrophecms/sanitize-html) or [insane](https://github.com/bevacqua/insane) on the output HTML! 🚨
|
||||
|
||||
**CLI**
|
||||
|
||||
``` bash
|
||||
$ marked -o hello.html
|
||||
hello world
|
||||
^D
|
||||
$ cat hello.html
|
||||
<p>hello world</p>
|
||||
```
|
||||
|
||||
**Browser**
|
||||
|
||||
```html
|
||||
<!doctype html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8"/>
|
||||
<title>Marked in the browser</title>
|
||||
</head>
|
||||
<body>
|
||||
<div id="content"></div>
|
||||
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
|
||||
<script>
|
||||
document.getElementById('content').innerHTML =
|
||||
marked('# Marked in the browser\n\nRendered by **marked**.');
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License)
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
# Security Policy
|
||||
|
||||
The only completely secure system is the one that doesn't exist in the first place.
|
||||
Having said that, we take the security of Marked very seriously.
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
Please disclose potential security issues by email to the project [committers](https://marked.js.org/#/AUTHORS.md) as well as the [listed owners within NPM](https://docs.npmjs.com/cli/owner).
|
||||
We will provide an initial assessment of security reports within 48 hours and should apply patches within 2 weeks
|
||||
(also, feel free to contribute a fix for the issue).
|
||||
|
|
@ -0,0 +1,215 @@
|
|||
#!/usr/bin/env node
|
||||
|
||||
/**
|
||||
* Marked CLI
|
||||
* Copyright (c) 2011-2013, Christopher Jeffrey (MIT License)
|
||||
*/
|
||||
|
||||
var fs = require('fs'),
|
||||
path = require('path'),
|
||||
marked = require('../');
|
||||
|
||||
/**
|
||||
* Man Page
|
||||
*/
|
||||
|
||||
function help() {
|
||||
var spawn = require('child_process').spawn;
|
||||
|
||||
var options = {
|
||||
cwd: process.cwd(),
|
||||
env: process.env,
|
||||
setsid: false,
|
||||
stdio: 'inherit'
|
||||
};
|
||||
|
||||
spawn('man', [path.resolve(__dirname, '/../man/marked.1')], options)
|
||||
.on('error', function() {
|
||||
fs.readFile(path.resolve(__dirname, '/../man/marked.1.txt'), 'utf8', function(err, data) {
|
||||
if (err) throw err;
|
||||
console.log(data);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
function version() {
|
||||
var pkg = require('../package.json');
|
||||
console.log(pkg.version);
|
||||
}
|
||||
|
||||
/**
|
||||
* Main
|
||||
*/
|
||||
|
||||
function main(argv, callback) {
|
||||
var files = [],
|
||||
options = {},
|
||||
input,
|
||||
output,
|
||||
string,
|
||||
arg,
|
||||
tokens,
|
||||
opt;
|
||||
|
||||
function getarg() {
|
||||
var arg = argv.shift();
|
||||
|
||||
if (arg.indexOf('--') === 0) {
|
||||
// e.g. --opt
|
||||
arg = arg.split('=');
|
||||
if (arg.length > 1) {
|
||||
// e.g. --opt=val
|
||||
argv.unshift(arg.slice(1).join('='));
|
||||
}
|
||||
arg = arg[0];
|
||||
} else if (arg[0] === '-') {
|
||||
if (arg.length > 2) {
|
||||
// e.g. -abc
|
||||
argv = arg.substring(1).split('').map(function(ch) {
|
||||
return '-' + ch;
|
||||
}).concat(argv);
|
||||
arg = argv.shift();
|
||||
} else {
|
||||
// e.g. -a
|
||||
}
|
||||
} else {
|
||||
// e.g. foo
|
||||
}
|
||||
|
||||
return arg;
|
||||
}
|
||||
|
||||
while (argv.length) {
|
||||
arg = getarg();
|
||||
switch (arg) {
|
||||
case '--test':
|
||||
return require('../test').main(process.argv.slice());
|
||||
case '-o':
|
||||
case '--output':
|
||||
output = argv.shift();
|
||||
break;
|
||||
case '-i':
|
||||
case '--input':
|
||||
input = argv.shift();
|
||||
break;
|
||||
case '-s':
|
||||
case '--string':
|
||||
string = argv.shift();
|
||||
break;
|
||||
case '-t':
|
||||
case '--tokens':
|
||||
tokens = true;
|
||||
break;
|
||||
case '-h':
|
||||
case '--help':
|
||||
return help();
|
||||
case '-v':
|
||||
case '--version':
|
||||
return version();
|
||||
default:
|
||||
if (arg.indexOf('--') === 0) {
|
||||
opt = camelize(arg.replace(/^--(no-)?/, ''));
|
||||
if (!marked.defaults.hasOwnProperty(opt)) {
|
||||
continue;
|
||||
}
|
||||
if (arg.indexOf('--no-') === 0) {
|
||||
options[opt] = typeof marked.defaults[opt] !== 'boolean'
|
||||
? null
|
||||
: false;
|
||||
} else {
|
||||
options[opt] = typeof marked.defaults[opt] !== 'boolean'
|
||||
? argv.shift()
|
||||
: true;
|
||||
}
|
||||
} else {
|
||||
files.push(arg);
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
function getData(callback) {
|
||||
if (!input) {
|
||||
if (files.length <= 2) {
|
||||
if (string) {
|
||||
return callback(null, string);
|
||||
}
|
||||
return getStdin(callback);
|
||||
}
|
||||
input = files.pop();
|
||||
}
|
||||
return fs.readFile(input, 'utf8', callback);
|
||||
}
|
||||
|
||||
return getData(function(err, data) {
|
||||
if (err) return callback(err);
|
||||
|
||||
data = tokens
|
||||
? JSON.stringify(marked.lexer(data, options), null, 2)
|
||||
: marked(data, options);
|
||||
|
||||
if (!output) {
|
||||
process.stdout.write(data + '\n');
|
||||
return callback();
|
||||
}
|
||||
|
||||
return fs.writeFile(output, data, callback);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Helpers
|
||||
*/
|
||||
|
||||
function getStdin(callback) {
|
||||
var stdin = process.stdin,
|
||||
buff = '';
|
||||
|
||||
stdin.setEncoding('utf8');
|
||||
|
||||
stdin.on('data', function(data) {
|
||||
buff += data;
|
||||
});
|
||||
|
||||
stdin.on('error', function(err) {
|
||||
return callback(err);
|
||||
});
|
||||
|
||||
stdin.on('end', function() {
|
||||
return callback(null, buff);
|
||||
});
|
||||
|
||||
try {
|
||||
stdin.resume();
|
||||
} catch (e) {
|
||||
callback(e);
|
||||
}
|
||||
}
|
||||
|
||||
function camelize(text) {
|
||||
return text.replace(/(\w)-(\w)/g, function(_, a, b) {
|
||||
return a + b.toUpperCase();
|
||||
});
|
||||
}
|
||||
|
||||
function handleError(err) {
|
||||
if (err.code === 'ENOENT') {
|
||||
console.error('marked: output to ' + err.path + ': No such directory');
|
||||
return process.exit(1);
|
||||
}
|
||||
throw err;
|
||||
}
|
||||
|
||||
/**
|
||||
* Expose / Entry Point
|
||||
*/
|
||||
|
||||
if (!module.parent) {
|
||||
process.title = 'marked';
|
||||
main(process.argv.slice(), function(err, code) {
|
||||
if (err) return handleError(err);
|
||||
return process.exit(code || 0);
|
||||
});
|
||||
} else {
|
||||
module.exports = main;
|
||||
}
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
{
|
||||
"name": "marked",
|
||||
"homepage": "https://github.com/markedjs/marked",
|
||||
"authors": [
|
||||
"Christopher Jeffrey <chjjeffrey@gmail.com>"
|
||||
],
|
||||
"description": "A markdown parser built for speed",
|
||||
"keywords": [
|
||||
"markdown",
|
||||
"markup",
|
||||
"html"
|
||||
],
|
||||
"main": "lib/marked.js",
|
||||
"license": "MIT",
|
||||
"ignore": [
|
||||
"**/.*",
|
||||
"node_modules",
|
||||
"bower_components",
|
||||
"app/bower_components",
|
||||
"test",
|
||||
"tests"
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
{
|
||||
"name": "marked",
|
||||
"version": "0.3.4",
|
||||
"repo": "markedjs/marked",
|
||||
"description": "A markdown parser built for speed",
|
||||
"keywords": ["markdown", "markup", "html"],
|
||||
"scripts": ["lib/marked.js"],
|
||||
"main": "lib/marked.js",
|
||||
"license": "MIT"
|
||||
}
|
||||
|
|
@ -0,0 +1,269 @@
|
|||
# Authors
|
||||
|
||||
Marked takes an encompassing approach to its community. As such, you can think of these as [concentric circles](https://medium.com/the-node-js-collection/healthy-open-source-967fa8be7951), where each group encompases the following groups.
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="center" valign="top" style="width:32%">
|
||||
<a href="https://github.com/chjj">
|
||||
<img width="100" height="100" src="https://github.com/chjj.png?s=150">
|
||||
</a>
|
||||
<br>
|
||||
<a href="https://github.com/chjj">Christopher Jeffrey</a>
|
||||
<div>Original Author</div>
|
||||
<small>Started the fire</small>
|
||||
</td>
|
||||
<td align="center" valign="top" style="width:32%">
|
||||
<a href="https://github.com/joshbruce">
|
||||
<img width="100" height="100" src="https://github.com/joshbruce.png?s=150">
|
||||
</a>
|
||||
<br>
|
||||
<a href="https://joshbruce.com">Josh Bruce</a>
|
||||
<div>Publisher</div>
|
||||
<small>Release Wrangler; Humaning Helper; Heckler of Hypertext</small>
|
||||
</td>
|
||||
<td align="center" valign="top" style="width:32%">
|
||||
<a href="https://github.com/styfle">
|
||||
<img width="100" height="100" src="https://github.com/styfle.png?s=150">
|
||||
</a>
|
||||
<br>
|
||||
<a href="https://www.ceriously.com">Steven</a>
|
||||
<div>Publisher</div>
|
||||
<small>Release Wrangler; Dr. Docs; Open source, of course; GitHub Guru; Humaning Helper</small>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center" valign="top">
|
||||
<a href="https://github.com/davisjam">
|
||||
<img width="100" height="100" src="https://github.com/davisjam.png?s=150">
|
||||
</a>
|
||||
<br>
|
||||
<a href="https://github.com/davisjam">Jamie Davis</a>
|
||||
<div>Committer</div>
|
||||
<small>Seeker of Security</small>
|
||||
</td>
|
||||
<td align="center" valign="top">
|
||||
<a href="https://github.com/UziTech">
|
||||
<img width="100" height="100" src="https://github.com/UziTech.png?s=150">
|
||||
</a>
|
||||
<br>
|
||||
<a href="https://tony.brix.ninja">Tony Brix</a>
|
||||
<div>Publisher</div>
|
||||
<small>Release Wrangler; Titan of the test harness; Dr. DevOps</small>
|
||||
</td>
|
||||
<td align="center" valign="top">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="center" valign="top">
|
||||
<a href="https://github.com/intcreator">
|
||||
<img width="100" height="100" src="https://github.com/intcreator.png?s=150">
|
||||
</a>
|
||||
<br>
|
||||
<a href="https://github.com/intcreator">Brandon der Blätter</a>
|
||||
<div>Contributor</div>
|
||||
<small>Curious Contributor</small>
|
||||
</td>
|
||||
<td align="center" valign="top">
|
||||
<a href="https://github.com/carlosvalle">
|
||||
<img width="100" height="100" src="https://github.com/carlosvalle.png?s=150">
|
||||
</a>
|
||||
<br>
|
||||
<a href="https://github.com/carlosvalle">Carlos Valle</a>
|
||||
<div>Contributor</div>
|
||||
<small>Maker of the Marked mark from 2018 to present</small>
|
||||
</td>
|
||||
<td align="center" width="20%" valign="top">
|
||||
<a href="https://github.com/Feder1co5oave">
|
||||
<img width="100" height="100" src="https://github.com/Feder1co5oave.png?s=150">
|
||||
</a>
|
||||
<br>
|
||||
<a href="https://github.com/Feder1co5oave">Federico Soave</a>
|
||||
<div>Contributor</div>
|
||||
<small>Regent of the Regex; Master of Marked</small>
|
||||
</td>
|
||||
<td align="center" valign="top">
|
||||
<a href="https://github.com/karenyavine">
|
||||
<img width="100" height="100" src="https://github.com/karenyavine.png?s=150">
|
||||
</a>
|
||||
<br>
|
||||
<a href="https://github.com/karenyavine">Karen Yavine</a>
|
||||
<div>Contributor</div>
|
||||
<small>Snyk's Security Saint</small>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center" valign="top">
|
||||
<a href="https://github.com/KostyaTretyak">
|
||||
<img width="100" height="100" src="https://github.com/KostyaTretyak.png?s=150">
|
||||
</a>
|
||||
<br>
|
||||
<a href="https://github.com/KostyaTretyak">Костя Третяк</a>
|
||||
<div>Contributor</div>
|
||||
<small></small>
|
||||
</td>
|
||||
<td align="center" width="20%" valign="top">
|
||||
<a href="https://github.com/tomtheisen">
|
||||
<img width="100" height="100" src="https://github.com/tomtheisen.png?s=150">
|
||||
</a>
|
||||
<br>
|
||||
<a href="https://github.com/tomtheisen">Tom Theisen</a>
|
||||
<div>Contributor</div>
|
||||
<small>Defibrillator</small>
|
||||
</td>
|
||||
<td align="center" width="20%" valign="top">
|
||||
<a href="https://github.com/mccraveiro">
|
||||
<img width="100" height="100" src="https://github.com/mccraveiro.png?s=150">
|
||||
</a>
|
||||
<br>
|
||||
<a href="https://github.com/mccraveiro">Mateus Craveiro</a>
|
||||
<div>Contributor</div>
|
||||
<small>Defibrillator</small>
|
||||
</td>
|
||||
<td align="center" width="20%" valign="top">
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Publishers
|
||||
|
||||
Publishers are admins who also have the responsibility, privilege, and burden of publishing the new releases to NPM and performing outreach and external stakeholder communications. Further, when things go pear-shaped, they're the ones taking most of the heat. Finally, when things go well, they're the primary ones praising the contributors who made it possible.
|
||||
|
||||
(In other words, while Admins are focused primarily on the internal workings of the project, Publishers are focused on internal *and* external concerns.)
|
||||
|
||||
**Should not exceed 2:** Having more people with the authority to publish a release can quickly turn into a consensus seeking nightmare (design by committee). Having only one is preferred (Directly Responsible Individual); however, given the nature of the project and its history, having an immediate fallback, and a potential deep fallback (Original author) is probably a good idea.
|
||||
|
||||
[Details on badges](#badges)
|
||||
|
||||
## Admins
|
||||
|
||||
Admins are committers who also have the responsibility, privilege, and burden of selecting committers and making sure the project itself runs smoothly, which includes community maintenance, governance, dispute resolution, and so on. (Letting the contributors easily enter into, and work within, the project to begin contributing, with as little friction as possible.)
|
||||
|
||||
**Should not exceed 3:** When there are too many people with the ability to resolve disputes, the dispute itself can quickly turn into a dispute amongst the admins themselves; therefore, we want this group to be small enough to commit to action and large enough to not put too much burden on one person. (Should ensure faster resolution and responsiveness.)
|
||||
|
||||
To be listed: Admins are usually selected from the pool of committers (or they volunteer, using the same process) who demonstrate good understanding of the marked culture, operations, and do their best to help new contributors get up to speed on how to contribute effectively to the project.
|
||||
|
||||
To be removed: You can remove yourself through the [GitHub UI](https://help.github.com/articles/removing-yourself-from-a-collaborator-s-repository/).
|
||||
|
||||
[Details on badges](#badges)
|
||||
|
||||
## Committers
|
||||
|
||||
Committers are contributors who also have the responsibility, privilege, some might even say burden of being able to review and merge contributions (just usually not their own).
|
||||
|
||||
A note on "decision making authority". This is related to submitting PRs and the [advice process](http://www.reinventingorganizationswiki.com/Decision_Making). The person marked as having decision making authority over a certain area should be sought for advice in that area before committing to a course of action.
|
||||
|
||||
**Should not exceed 5:** For larger PRs affecting more of the codebase and, most likely, review by more people, we try to keep this pool small and responsive and let those with decision making authority have final say without negative repercussions from the other committers.
|
||||
|
||||
To be listed: Committers are usually selected (or they volunteer, using the same process) from contributors who enter the discussions regarding the future direction of Marked (maybe even doing informal reviews of contributions despite not being able to merge them yourself).
|
||||
|
||||
To be removed: You can remove yourself through the [GitHub UI](https://help.github.com/articles/removing-yourself-from-a-collaborator-s-repository/).
|
||||
|
||||
A note on volunteering:
|
||||
|
||||
1. Please do not volunteer unless you believe you can demonstrate to your peers you can do the work required.
|
||||
2. Please do not overcommit yourself; we count on those committed to the project to be responsive. Really consider, with all you have going on, wehther you able to really commit to it.
|
||||
3. Don't let the previous frighten you away, it can always be changed later by you or your peers.
|
||||
|
||||
[Details on badges](#badges)
|
||||
|
||||
## Contributors
|
||||
|
||||
Contributors are users who submit a [PR](https://github.com/markedjs/marked/pulls), [Issue](https://github.com/markedjs/marked/issues), or collaborate in making Marked a better product and experience for all the users.
|
||||
|
||||
To be listed: make a contribution and, if it has significant impact, the committers may be able to add you here.
|
||||
|
||||
To be removed: please let us know or submit a PR.
|
||||
|
||||
[Details on badges](#badges)
|
||||
|
||||
## Users
|
||||
|
||||
Users are anyone using Marked in some fashion, without them, there's no reason for us to exist.
|
||||
|
||||
|Individual or Organization |Website |Project |Submitted by |
|
||||
|:--------------------------|:-----------------------|:------------------------------------|:---------------------------------------------------|
|
||||
|MarkedJS |https://marked.js.org |https://github.com/markedjs/marked |The marked committers |
|
||||
|
||||
To be listed: All fields are optional. Contact any of the committers or, more timely, submit a pull request with the following (using the first row as an example):
|
||||
|
||||
- **Individual or Organization:** The name you would like associated with the record.
|
||||
- **Website:** A URL to a standalone website for the project.
|
||||
- **Project:** A URL for the repository of the project using marked.
|
||||
- **Submitted by:** The name and optional honorifics for the person adding the listing.
|
||||
|
||||
To be removed: Same as above. Only instead of requesting addition request deletion or delete the row yourself.
|
||||
|
||||
<h2 id="badges">Badges</h2>
|
||||
|
||||
Badges? You don't *need* no stinkin' badges.
|
||||
|
||||
Movie references aside. (It was either that or, "Let's play a game", but that would have been creepy…that's why it will most likely come later.)
|
||||
|
||||
Badges? If you *want* 'em, we got 'em, and here's how you get 'em (and…dramatic pause…why not two dramatic pauses for emphasis?… how they can be taken away).
|
||||
|
||||
- [ ] Add the appropriate badge to the desired contributor in the desired column of this page, even if they're not listed here yet.
|
||||
- [ ] Submit a PR (we're big on PRs around here, if you haven't noticed, help us help you).
|
||||
- [ ] Follow the instructions for submitting a badge PR. (There are more details to find within. Come on. Everybody likes surprises, right? No? Actually, we just try to put documentation where it belongs, closer to the code and part of the sequence of events.)
|
||||
|
||||
### Badges at play:
|
||||
|
||||
<dl>
|
||||
<dt>Curious Contributor</dt>
|
||||
<dd>A contributor with less than one year on this page who is actively engaged in submitting PRs, Issues, making recommendations, sharing thoughts…without being too annoying about it (let's be clear, submitting 100 Issues recommending the Marked Committers send everyone candy is trying for the badge, not honestly earning it).</dd>
|
||||
<dt>Dr. DevOps</dt>
|
||||
<dd>
|
||||
<p>Someone who understands and contributes to improving the developer experience and flow of Marked into the world.</p>
|
||||
<blockquote>
|
||||
"The main characteristic of the DevOps movement is to strongly advocate automation and monitoring at all steps of software construction, from integration, testing, releasing to deployment and infrastructure management. DevOps aims at shorter development cycles, increased deployment frequency, more dependable releases, in close alignment with business objectives." ~ <a href="https://www.wikipedia.org/wiki/DevOps">Wikipedia</a>
|
||||
</blockquote>
|
||||
</dd>
|
||||
<dt>Dr. Docs</dt>
|
||||
<dd>Someone who has contributed a great deal to the creation and maintainance of the non-code areas of marked.</dd>
|
||||
<dt>Eye for the CLI</dt>
|
||||
<dd>At this point? Pretty much anyone who can update that `man` file to the current Marked version without regression in the CLI tool itself.</dd>
|
||||
<dt>GitHub Guru</dt>
|
||||
<dd>Someone who always seems to be able to tell you easier ways to do things with GitHub.</dd>
|
||||
<dt>Humaning Helper</dt>
|
||||
<dd>Someone who goes out of their way to help contributors feel welcomed and valued. Further, someone who takes the extra steps(s) necessary to help new contributors get up to speed. Finally, they maintain composure even in times of disagreement and dispute resolution.</dd>
|
||||
<dt>Heckler of Hypertext</dt>
|
||||
<dd>Someone who demonstrates an esoteric level of knowledge when it comes to HTML. In other words, someone who says things like, "Did you know most Markdown flavors don't have a way to render a description list (`dl`)? All the more reason Markdown `!==` HTML."</dd>
|
||||
<dt>Markdown Maestro</dt>
|
||||
<dd>You know that person who knows about way too many different flavors of Markdown? The one who maybe seems a little too obsessed with the possibilities of Markdown beyond HTML? Come on. You know who they are. Or, at least you could, if you give them this badge.</dd>
|
||||
<dt>Master of Marked</dt>
|
||||
<dd>Someone who demonstrates they know the ins and outs of the codebase for Marked.</dd>
|
||||
<dt>Open source, of course</dt>
|
||||
<dd>Someone who advocates for and has a proven understanding of how to operate within open source communities.</dd>
|
||||
<dt>Regent of the Regex</dt>
|
||||
<dd><p>Can you demonstrate you understand the following without Google and Stackoverflow?</p>
|
||||
<p><code>/^( *)(bull) [\s\S]+?(?:hr|def|\n{2,}(?! )(?!\1bull )\n*|\s*$)/</code></p>
|
||||
<p>Because this author can't yet. That's who gets these.</p>
|
||||
</dd>
|
||||
<dt>Seeker of Security</dt>
|
||||
<dd>Someone who has demonstrated a high degree of expertise or authority when it comes to software security.</dd>
|
||||
<dt>Titan of the Test Harness</dt>
|
||||
<dd>Someone who demonstrates high-levels of understanding regarding Marked's test harness.</dd>
|
||||
<dt>Totally Tron</dt>
|
||||
<dd>Someone who demonstrates they are willing and able to "fight for the users", both developers dependent on marked to do their jobs as well as end-users interacting with the output (particularly in the realm of those with the disabilities).</dd>
|
||||
</dl>
|
||||
|
||||
### Special badges that come with the job:
|
||||
|
||||
<dl>
|
||||
<dt>Defibrillator</dt>
|
||||
<dd>A contributor who stepped up to help bring Marked back to life by contriuting solutions to help Marked pass when compared against the CommonMark and GitHub Flavored Markdown specifications.</dd>
|
||||
<dt>Maker of the Marked mark</dt>
|
||||
<dd>This badge is given to the person or oganization credited with creating the logo (or logotype) used in Marked communications for a given period of time. **Maker of the Marked mark from 2017 to present**, for example.</dd>
|
||||
<dt>Release Wrangler</dt>
|
||||
<dd>This is a badge given to all Publishers.</dd>
|
||||
<dt>Snyk's Security Saint</dt>
|
||||
<dd>This is a badge given to whomever primarily reaches out from Snyk to let us know about security issues.</dd>
|
||||
</dl>
|
||||
|
|
@ -0,0 +1 @@
|
|||
marked.js.org
|
||||
|
|
@ -0,0 +1,74 @@
|
|||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, gender identity and expression, level of experience,
|
||||
nationality, personal appearance, race, religion, or sexual identity and
|
||||
orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or
|
||||
advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic
|
||||
address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to block temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. Examples of
|
||||
representing a project or community include using an official project e-mail
|
||||
address, posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team by submitting a PR with changes to the [AUTHORS](#/AUTHORS.md) page (or emailing josh@8fold.com). All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and appropriate to the circumstances. The project team is
|
||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version [1.4][version].
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org/
|
||||
[version]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||
|
|
@ -0,0 +1,94 @@
|
|||
# Contributing to Marked
|
||||
|
||||
- [ ] Fork `markedjs/marked`.
|
||||
- [ ] Clone the library locally using GitHub Desktop or the command line.
|
||||
- [ ] Make sure you are on the `master` branch.
|
||||
- [ ] Be sure to run `npm install` or `npm update`.
|
||||
- [ ] Create a branch.
|
||||
- [ ] Make as small a change as possible.
|
||||
- [ ] Run `npm test`, fix any broken things (for linting, you can run `npm run lint` to have the linter fix them for you).
|
||||
- [ ] Submit a PR.
|
||||
|
||||
## Design principles
|
||||
|
||||
Marked tends to favor following the SOLID set of software design and development principles; mainly the [single responsibility](https://en.wikipedia.org/wiki/Single_responsibility_principle) and [open/closed principles](https://en.wikipedia.org/wiki/Open/closed_principle):
|
||||
|
||||
- **Single responsibility:** Marked, and the components of Marked, have the single responsibility of converting Markdown strings into HTML.
|
||||
- **Open/closed:** Marked favors giving developers the means to easily extend the library and its components over changing Marked's behavior through configuration options.
|
||||
|
||||
## Priorities
|
||||
|
||||
We think we have our priorities sorted to build quality in.
|
||||
|
||||
The following table lists the ticket type labels we use when there is work to be done on the code either through an Issue or a PR; in priority order.
|
||||
|
||||
|Ticket type label |Description |
|
||||
|:----------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
|L0 - security |A security vulnerability within the Marked library is discovered. |
|
||||
|L1 - broken |Valid usage results in incorrect output compared to [supported specifications](#/README.md#specifications) OR causes marked to crash AND there is no known workaround for the issue. |
|
||||
|L2 - annoying |Similar to L1 - broken only there is a known workaround available for the issue. |
|
||||
|RR - refactor and re-engineer |Results in an improvement to developers using Marked (improved readability) or end-users (faster performance) or both. |
|
||||
|NFS - new feature (spec related) |A capability Marked does not currently provide but is in one of the [supported specifications](#/README.md#specifications) |
|
||||
|NFU - new feature (user requested) |A capability Marked does not currently provide but has been requested by users of Marked. |
|
||||
|
||||
## Test early, often, and everything
|
||||
|
||||
We try to write test cases to validate output (writing tests based on the [supported specifications](#/README.md#specifications)) and minimize regression (writing tests for issues fixed). Therefore, if you would like to contribute, some things you should know regarding the test harness.
|
||||
|
||||
|Location |Description |
|
||||
|:---------------------|:--------------------------------------------------------------------------------------------------------------|
|
||||
|/test/specs/commonmark|Tests for [CommonMark](https://spec.commonmark.org/current/) compliance |
|
||||
|/test/specs/gfm |Tests for [GFM](https://github.github.com/gfm/) compliance |
|
||||
|/test/specs/new |Tests not related to the original `markdown.pl`. |
|
||||
|/test/specs/original |Tests validating against the original `markdown.pl`. |
|
||||
|/test/specs/redos |Tests for [ReDOS](https://www.owasp.org/index.php/Regular_expression_Denial_of_Service_-_ReDoS) vulnerabilities|
|
||||
|
||||
If your test uses features or options, assuming `gfm` is set to `false`, for example, you can add [front-matter](https://www.npmjs.com/package/front-matter) to the top of
|
||||
your `.md` file
|
||||
|
||||
``` yml
|
||||
---
|
||||
gfm: false
|
||||
---
|
||||
```
|
||||
|
||||
## Submitting PRs and Issues
|
||||
|
||||
Marked provides templates for submitting both pull requests and issues. When you begin creating a new PR or issue, you will see instructions on using the template.
|
||||
|
||||
The PR templates include checklists for both the submitter and the reviewer, which, in most cases, will not be the same person.
|
||||
|
||||
## Scripts
|
||||
|
||||
When it comes to NPM commands, we try to use the native scripts provided by the NPM framework.
|
||||
|
||||
To run the tests:
|
||||
|
||||
``` bash
|
||||
npm test
|
||||
```
|
||||
|
||||
To test whether you are using the standard syntax rules for the project:
|
||||
|
||||
```bash
|
||||
npm run test:lint
|
||||
```
|
||||
|
||||
To see time comparisons between Marked and other popular Markdown libraries:
|
||||
|
||||
```bash
|
||||
npm run bench
|
||||
```
|
||||
|
||||
To check for (and fix) standardized syntax (lint):
|
||||
|
||||
```bash
|
||||
npm run lint
|
||||
```
|
||||
|
||||
To build your own minified version of Marked:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# Releasing Marked
|
||||
|
||||
- [ ] See [contributing](#/CONTRIBUTING.md)
|
||||
- [ ] Create release branch from `master` (`release-x.y.z`)
|
||||
- [ ] Submit PR with minimal name: Release x.y.z
|
||||
- [ ] Complete PR checklists
|
||||
|
||||
## Overall strategy
|
||||
|
||||
**Master is always shippable:** We try to merge PRs in such a way that `master` is the only branch to really be concerned about *and* `master` can always be released. This allows smoother flow between new fetures, bug fixes, and so on. (Almost a continuous deployment setup, without automation.)
|
||||
|
||||
## Versioning
|
||||
|
||||
We follow [semantic versioning](https://semver.org) where the following sequence is true `[major].[minor].[patch]`; therefore, consider the following implications of the release you are preparing:
|
||||
|
||||
1. **Major:** There is at least one change not deemed backward compatible.
|
||||
2. **Minor:** There is at least one new feature added to the release.
|
||||
3. **Patch:** No breaking changes, no new features.
|
||||
|
||||
What to expect while Marked is a zero-major (0.x.y):
|
||||
|
||||
1. The major will remain at zero; thereby, alerting consumers to the potentially volatile nature of the package.
|
||||
2. The minor will tend to be more analagous to a `major` release.
|
||||
3. The patch will tend to be more analagous to a `minor` release or a collection of bug fixes (patches).
|
||||
|
|
@ -0,0 +1,85 @@
|
|||
Marked is
|
||||
|
||||
1. built for speed.<sup>*</sup>
|
||||
2. a low-level markdown compiler for parsing markdown without caching or blocking for long periods of time.<sup>**</sup>
|
||||
3. light-weight while implementing all markdown features from the supported flavors & specifications.<sup>***</sup>
|
||||
4. available as a command line interface (CLI) and running in client- or server-side JavaScript projects.
|
||||
|
||||
<p><small><sup>*</sup> Still working on metrics for comparative analysis and definition.</small><br>
|
||||
<small><sup>**</sup> As few dependencies as possible.</small><br>
|
||||
<small><sup>***</sup> Strict compliance could result in slower processing when running comparative benchmarking.</small></p>
|
||||
|
||||
|
||||
<h2 id="demo">Demo</h2>
|
||||
|
||||
Checkout the [demo page](./demo/) to see marked in action ⛹️
|
||||
|
||||
These documentation pages are also rendered using marked 💯
|
||||
|
||||
|
||||
<h2 id="installation">Installation</h2>
|
||||
|
||||
**CLI:** `npm install -g marked`
|
||||
|
||||
**In-browser:** `npm install marked`
|
||||
|
||||
<h2 id="usage">Usage</h2>
|
||||
|
||||
### Warning: 🚨 Marked does not [sanitize](https://marked.js.org/#/USING_ADVANCED.md#options) the output HTML. Please use a sanitize library, like [DOMPurify](https://github.com/cure53/DOMPurify) (recommended), [sanitize-html](https://github.com/apostrophecms/sanitize-html) or [insane](https://github.com/bevacqua/insane) on the output HTML! 🚨
|
||||
|
||||
**CLI**
|
||||
|
||||
``` bash
|
||||
$ marked -o hello.html
|
||||
hello world
|
||||
^D
|
||||
$ cat hello.html
|
||||
<p>hello world</p>
|
||||
```
|
||||
|
||||
``` bash
|
||||
$ marked -s "*hello world*"
|
||||
<p><em>hello world</em></p>
|
||||
```
|
||||
|
||||
**Browser**
|
||||
|
||||
```html
|
||||
<!doctype html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8"/>
|
||||
<title>Marked in the browser</title>
|
||||
</head>
|
||||
<body>
|
||||
<div id="content"></div>
|
||||
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
|
||||
<script>
|
||||
document.getElementById('content').innerHTML =
|
||||
marked('# Marked in browser\n\nRendered by **marked**.');
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
|
||||
Marked offers [advanced configurations](#/USING_ADVANCED.md) and [extensibility](#/USING_PRO.md) as well.
|
||||
|
||||
<h2 id="specifications">Supported Markdown specifications</h2>
|
||||
|
||||
We actively support the features of the following [Markdown flavors](https://github.com/commonmark/CommonMark/wiki/Markdown-Flavors).
|
||||
|
||||
|Flavor |Version |
|
||||
|:----------------------------------------------------------|:----------|
|
||||
|The original markdown.pl |-- |
|
||||
|[CommonMark](http://spec.commonmark.org/0.29/) |0.29 |
|
||||
|[GitHub Flavored Markdown](https://github.github.com/gfm/) |0.29 |
|
||||
|
||||
By supporting the above Markdown flavors, it's possible that Marked can help you use other flavors as well; however, these are not actively supported by the community.
|
||||
|
||||
<h2 id="security">Security</h2>
|
||||
|
||||
The only completely secure system is the one that doesn't exist in the first place. Having said that, we take the security of Marked very seriously.
|
||||
|
||||
Therefore, please disclose potential security issues by email to the project [committers](#/AUTHORS.md) as well as the [listed owners within NPM](https://docs.npmjs.com/cli/owner). We will provide an initial assessment of security reports within 48 hours and should apply patches within 2 weeks (also, feel free to contribute a fix for the issue).
|
||||
|
||||
|
|
@ -0,0 +1,154 @@
|
|||
## The `marked` function
|
||||
|
||||
```js
|
||||
marked(markdownString [,options] [,callback])
|
||||
```
|
||||
|
||||
|Argument |Type |Notes |
|
||||
|:---------------------|:------------|:----------------------------------------------------------------------------------------------------|
|
||||
|markdownString |`string` |String of markdown source to be compiled. |
|
||||
|<a href="#options">options</a>|`object`|Hash of options. Can also use `marked.setOptions`. |
|
||||
|callback |`function` |Called when `markdownString` has been parsed. Can be used as second argument if no `options` present.|
|
||||
|
||||
### Alternative using reference
|
||||
|
||||
```js
|
||||
// Create reference instance
|
||||
const marked = require('marked');
|
||||
|
||||
// Set options
|
||||
// `highlight` example uses `highlight.js`
|
||||
marked.setOptions({
|
||||
renderer: new marked.Renderer(),
|
||||
highlight: function(code) {
|
||||
return require('highlight.js').highlightAuto(code).value;
|
||||
},
|
||||
pedantic: false,
|
||||
gfm: true,
|
||||
breaks: false,
|
||||
sanitize: false,
|
||||
smartLists: true,
|
||||
smartypants: false,
|
||||
xhtml: false
|
||||
});
|
||||
|
||||
// Compile
|
||||
console.log(marked(markdownString));
|
||||
```
|
||||
|
||||
<h2 id="options">Options</h2>
|
||||
|
||||
|Member |Type |Default |Since |Notes |
|
||||
|:-----------|:---------|:--------|:--------|:-------------|
|
||||
|baseUrl |`string` |`null` |0.3.9 |A prefix url for any relative link. |
|
||||
|breaks |`boolean` |`false` |v0.2.7 |If true, add `<br>` on a single line break (copies GitHub). Requires `gfm` be `true`.|
|
||||
|gfm |`boolean` |`true` |v0.2.1 |If true, use approved [GitHub Flavored Markdown (GFM) specification](https://github.github.com/gfm/).|
|
||||
|headerIds |`boolean` |`true` |v0.4.0 |If true, include an `id` attribute when emitting headings (h1, h2, h3, etc).|
|
||||
|headerPrefix|`string` |`''` |v0.3.0 |A string to prefix the `id` attribute when emitting headings (h1, h2, h3, etc).|
|
||||
|highlight |`function`|`null` |v0.3.0 |A function to highlight code blocks, see <a href="#highlight">Asynchronous highlighting</a>.|
|
||||
|langPrefix |`string` |`'language-'`|v0.3.0|A string to prefix the className in a `<code>` block. Useful for syntax highlighting.|
|
||||
|mangle |`boolean` |`true` |v0.3.4 |If true, autolinked email address is escaped with HTML character references.|
|
||||
|pedantic |`boolean` |`false` |v0.2.1 |If true, conform to the original `markdown.pl` as much as possible. Don't fix original markdown bugs or behavior. Turns off and overrides `gfm`.|
|
||||
|renderer |`object` |`new Renderer()`|v0.3.0|An object containing functions to render tokens to HTML. See [extensibility](USING_PRO.md) for more details.|
|
||||
|sanitize |`boolean` |`false` |v0.2.1 |If true, sanitize the HTML passed into `markdownString` with the `sanitizer` function.<br>**Warning**: This feature is deprecated and it should NOT be used as it cannot be considered secure.<br>Instead use a sanitize library, like [DOMPurify](https://github.com/cure53/DOMPurify) (recommended), [sanitize-html](https://github.com/apostrophecms/sanitize-html) or [insane](https://github.com/bevacqua/insane) on the output HTML! |
|
||||
|sanitizer |`function`|`null` |v0.3.4 |A function to sanitize the HTML passed into `markdownString`.|
|
||||
|silent |`boolean` |`false` |v0.2.7 |If true, the parser does not throw any exception.|
|
||||
|smartLists |`boolean` |`false` |v0.2.8 |If true, use smarter list behavior than those found in `markdown.pl`.|
|
||||
|smartypants |`boolean` |`false` |v0.2.9 |If true, use "smart" typographic punctuation for things like quotes and dashes.|
|
||||
|xhtml |`boolean` |`false` |v0.3.2 |If true, emit self-closing HTML tags for void elements (<br/>, <img/>, etc.) with a "/" as required by XHTML.|
|
||||
|
||||
<h2 id="highlight">Asynchronous highlighting</h2>
|
||||
|
||||
Unlike `highlight.js` the `pygmentize.js` library uses asynchronous highlighting. This example demonstrates that marked is agnostic when it comes to the highlighter you use.
|
||||
|
||||
```js
|
||||
marked.setOptions({
|
||||
highlight: function(code, lang, callback) {
|
||||
require('pygmentize-bundled') ({ lang: lang, format: 'html' }, code, function (err, result) {
|
||||
callback(err, result.toString());
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
console.log(marked(markdownString));
|
||||
```
|
||||
|
||||
In both examples, `code` is a `string` representing the section of code to pass to the highlighter. In this example, `lang` is a `string` informing the highlighter what programming lnaguage to use for the `code` and `callback` is the `function` the asynchronous highlighter will call once complete.
|
||||
|
||||
<h2 id="workers">Workers</h2>
|
||||
|
||||
To prevent ReDoS attacks you can run marked on a worker and terminate it when parsing takes longer than usual.
|
||||
|
||||
Marked can be run in a [worker thread](https://nodejs.org/api/worker_threads.html) on a node server, or a [web worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) in a browser.
|
||||
|
||||
### Node Worker Thread
|
||||
|
||||
> 🚨 Node Worker Threads are [experimental](https://nodejs.org/api/worker_threads.html#worker_threads_worker_threads) 🚨
|
||||
>
|
||||
> This implementation may change.
|
||||
|
||||
```js
|
||||
// markedWorker.js
|
||||
|
||||
const marked = require('marked');
|
||||
const { parentPort } = require('worker_threads');
|
||||
|
||||
parentPort.on('message', (markdownString) => {
|
||||
parentPort.postMessage(marked(markdownString));
|
||||
});
|
||||
```
|
||||
|
||||
```js
|
||||
// index.js
|
||||
|
||||
const { Worker } = require('worker_threads');
|
||||
const markedWorker = new Worker('./markedWorker.js');
|
||||
|
||||
const markedTimeout = setTimeout(() => {
|
||||
markedWorker.terminate();
|
||||
throw new Error('Marked took too long!');
|
||||
}, timeoutLimit);
|
||||
|
||||
markedWorker.on('message', (html) => {
|
||||
clearTimeout(markedTimeout);
|
||||
console.log(html);
|
||||
markedWorker.terminate();
|
||||
});
|
||||
|
||||
markedWorker.postMessage(markdownString);
|
||||
```
|
||||
|
||||
### Web Worker
|
||||
|
||||
> **NOTE**: Web Workers send the payload from `postMessage` in an object with the payload in a `.data` property
|
||||
|
||||
```js
|
||||
// markedWorker.js
|
||||
|
||||
importScripts('path/to/marked.min.js');
|
||||
|
||||
onmessage = (e) => {
|
||||
const markdownString = e.data
|
||||
postMessage(marked(markdownString));
|
||||
};
|
||||
```
|
||||
|
||||
```js
|
||||
// script.js
|
||||
|
||||
const markedWorker = new Worker('./markedWorker.js');
|
||||
|
||||
const markedTimeout = setTimeout(() => {
|
||||
markedWorker.terminate();
|
||||
throw new Error('Marked took too long!');
|
||||
}, timeoutLimit);
|
||||
|
||||
markedWorker.onmessage = (e) => {
|
||||
clearTimeout(markedTimeout);
|
||||
const html = e.data;
|
||||
console.log(html);
|
||||
markedWorker.terminate();
|
||||
};
|
||||
|
||||
markedWorker.postMessage(markdownString);
|
||||
```
|
||||
|
|
@ -0,0 +1,163 @@
|
|||
## Extending Marked
|
||||
|
||||
To champion the single-responsibility and open/closed prinicples, we have tried to make it relatively painless to extend marked. If you are looking to add custom functionality, this is the place to start.
|
||||
|
||||
<h2 id="renderer">The renderer</h2>
|
||||
|
||||
The renderer is...
|
||||
|
||||
**Example:** Overriding default heading token by adding an embedded anchor tag like on GitHub.
|
||||
|
||||
```js
|
||||
// Create reference instance
|
||||
var myMarked = require('marked');
|
||||
|
||||
// Get reference
|
||||
var renderer = new myMarked.Renderer();
|
||||
|
||||
// Override function
|
||||
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}>`;
|
||||
};
|
||||
|
||||
// Run marked
|
||||
console.log(myMarked('# heading+', { renderer: renderer }));
|
||||
```
|
||||
|
||||
**Output:**
|
||||
|
||||
```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* infostring, *boolean* escaped)
|
||||
- blockquote(*string* quote)
|
||||
- html(*string* html)
|
||||
- heading(*string* text, *number* level, *string* raw, *Slugger* slugger)
|
||||
- hr()
|
||||
- list(*string* body, *boolean* ordered, *number* start)
|
||||
- listitem(*string* text, *boolean* task, *boolean* checked)
|
||||
- checkbox(*boolean* checked)
|
||||
- paragraph(*string* text)
|
||||
- table(*string* header, *string* body)
|
||||
- tablerow(*string* content)
|
||||
- tablecell(*string* content, *object* flags)
|
||||
|
||||
`slugger` has the `slug` method to create an unique id from value:
|
||||
|
||||
```js
|
||||
slugger.slug('foo') // foo
|
||||
slugger.slug('foo') // foo-1
|
||||
slugger.slug('foo') // foo-2
|
||||
slugger.slug('foo 1') // foo-1-1
|
||||
slugger.slug('foo-1') // foo-1-2
|
||||
...
|
||||
```
|
||||
|
||||
`flags` has the following properties:
|
||||
|
||||
```js
|
||||
{
|
||||
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)
|
||||
- text(*string* text)
|
||||
|
||||
<h2 id="lexer">The lexer</h2>
|
||||
|
||||
The lexer is...
|
||||
|
||||
|
||||
<h2 id="parser">The parser</h2>
|
||||
|
||||
The parser is...
|
||||
|
||||
***
|
||||
|
||||
<h2 id="extend">Access to lexer and parser</h2>
|
||||
|
||||
You also have direct access to the lexer and parser if you so desire.
|
||||
|
||||
``` js
|
||||
var tokens = marked.lexer(text, options);
|
||||
console.log(marked.parser(tokens));
|
||||
```
|
||||
|
||||
``` js
|
||||
var lexer = new marked.Lexer(options);
|
||||
var tokens = lexer.lex(text);
|
||||
console.log(tokens);
|
||||
console.log(lexer.rules);
|
||||
```
|
||||
|
||||
``` bash
|
||||
$ node
|
||||
> require('marked').lexer('> i am using marked.')
|
||||
[ { type: 'blockquote_start' },
|
||||
{ type: 'paragraph',
|
||||
text: 'i am using marked.' },
|
||||
{ type: 'blockquote_end' },
|
||||
links: {} ]
|
||||
```
|
||||
|
||||
The Lexers build an array of tokens, which will be passed to their respective
|
||||
Parsers. The Parsers process each token in the token arrays,
|
||||
which are removed from the array of tokens:
|
||||
|
||||
``` js
|
||||
const marked = require('marked');
|
||||
|
||||
const md = `
|
||||
# heading
|
||||
|
||||
[link][1]
|
||||
|
||||
[1]: #heading "heading"
|
||||
`;
|
||||
|
||||
const tokens = marked.lexer(md);
|
||||
console.log(tokens);
|
||||
|
||||
const html = marked.parser(tokens);
|
||||
console.log(html);
|
||||
|
||||
console.log(tokens);
|
||||
```
|
||||
|
||||
``` bash
|
||||
[ { type: 'heading', depth: 1, text: 'heading' },
|
||||
{ type: 'paragraph', text: ' [link][1]' },
|
||||
{ type: 'space' },
|
||||
links: { '1': { href: '#heading', title: 'heading' } } ]
|
||||
|
||||
<h1 id="heading">heading</h1>
|
||||
<p> <a href="#heading" title="heading">link</a></p>
|
||||
|
||||
[ links: { '1': { href: '#heading', title: 'heading' } } ]
|
||||
```
|
||||
|
|
@ -0,0 +1,426 @@
|
|||
# Markdown is broken
|
||||
|
||||
I have a lot of scraps of markdown engine oddities that I've collected over the
|
||||
years. What you see below is slightly messy, but it's what I've managed to
|
||||
cobble together to illustrate the differences between markdown engines, and
|
||||
why, if there ever is a markdown specification, it has to be absolutely
|
||||
thorough. There are a lot more of these little differences I have documented
|
||||
elsewhere. I know I will find them lingering on my disk one day, but until
|
||||
then, I'll continue to add whatever strange nonsensical things I find.
|
||||
|
||||
Some of these examples may only mention a particular engine compared to marked.
|
||||
However, the examples with markdown.pl could easily be swapped out for
|
||||
discount, upskirt, or markdown.js, and you would very easily see even more
|
||||
inconsistencies.
|
||||
|
||||
A lot of this was written when I was very unsatisfied with the inconsistencies
|
||||
between markdown engines. Please excuse the frustration noticeable in my
|
||||
writing.
|
||||
|
||||
## Examples of markdown's "stupid" list parsing
|
||||
|
||||
```
|
||||
$ markdown.pl
|
||||
|
||||
* item1
|
||||
|
||||
* item2
|
||||
|
||||
text
|
||||
^D
|
||||
<ul>
|
||||
<li><p>item1</p>
|
||||
|
||||
<ul>
|
||||
<li>item2</li>
|
||||
</ul>
|
||||
|
||||
<p><p>text</p></li>
|
||||
</ul></p>
|
||||
```
|
||||
|
||||
|
||||
```
|
||||
$ marked
|
||||
* item1
|
||||
|
||||
* item2
|
||||
|
||||
text
|
||||
^D
|
||||
<ul>
|
||||
<li><p>item1</p>
|
||||
<ul>
|
||||
<li>item2</li>
|
||||
</ul>
|
||||
<p>text</p>
|
||||
</li>
|
||||
</ul>
|
||||
```
|
||||
|
||||
Which looks correct to you?
|
||||
|
||||
- - -
|
||||
|
||||
```
|
||||
$ markdown.pl
|
||||
* hello
|
||||
> world
|
||||
^D
|
||||
<p><ul>
|
||||
<li>hello</p>
|
||||
|
||||
<blockquote>
|
||||
<p>world</li>
|
||||
</ul></p>
|
||||
</blockquote>
|
||||
```
|
||||
|
||||
```
|
||||
$ marked
|
||||
* hello
|
||||
> world
|
||||
^D
|
||||
<ul>
|
||||
<li>hello<blockquote>
|
||||
<p>world</p>
|
||||
</blockquote>
|
||||
</li>
|
||||
</ul>
|
||||
```
|
||||
|
||||
Again, which looks correct to you?
|
||||
|
||||
- - -
|
||||
|
||||
EXAMPLE:
|
||||
|
||||
```
|
||||
$ markdown.pl
|
||||
* hello
|
||||
* world
|
||||
* hi
|
||||
code
|
||||
^D
|
||||
<ul>
|
||||
<li>hello
|
||||
<ul>
|
||||
<li>world</li>
|
||||
<li>hi
|
||||
code</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
```
|
||||
|
||||
The code isn't a code block even though it's after the bullet margin. I know,
|
||||
lets give it two more spaces, effectively making it 8 spaces past the bullet.
|
||||
|
||||
```
|
||||
$ markdown.pl
|
||||
* hello
|
||||
* world
|
||||
* hi
|
||||
code
|
||||
^D
|
||||
<ul>
|
||||
<li>hello
|
||||
<ul>
|
||||
<li>world</li>
|
||||
<li>hi
|
||||
code</li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
```
|
||||
|
||||
And, it's still not a code block. Did you also notice that the 3rd item isn't
|
||||
even its own list? Markdown screws that up too because of its indentation
|
||||
unaware parsing.
|
||||
|
||||
- - -
|
||||
|
||||
Let's look at some more examples of markdown's list parsing:
|
||||
|
||||
```
|
||||
$ markdown.pl
|
||||
|
||||
* item1
|
||||
|
||||
* item2
|
||||
|
||||
text
|
||||
^D
|
||||
<ul>
|
||||
<li><p>item1</p>
|
||||
|
||||
<ul>
|
||||
<li>item2</li>
|
||||
</ul>
|
||||
|
||||
<p><p>text</p></li>
|
||||
</ul></p>
|
||||
```
|
||||
|
||||
Misnested tags.
|
||||
|
||||
|
||||
```
|
||||
$ marked
|
||||
* item1
|
||||
|
||||
* item2
|
||||
|
||||
text
|
||||
^D
|
||||
<ul>
|
||||
<li><p>item1</p>
|
||||
<ul>
|
||||
<li>item2</li>
|
||||
</ul>
|
||||
<p>text</p>
|
||||
</li>
|
||||
</ul>
|
||||
```
|
||||
|
||||
Which looks correct to you?
|
||||
|
||||
- - -
|
||||
|
||||
```
|
||||
$ markdown.pl
|
||||
* hello
|
||||
> world
|
||||
^D
|
||||
<p><ul>
|
||||
<li>hello</p>
|
||||
|
||||
<blockquote>
|
||||
<p>world</li>
|
||||
</ul></p>
|
||||
</blockquote>
|
||||
```
|
||||
|
||||
More misnested tags.
|
||||
|
||||
|
||||
```
|
||||
$ marked
|
||||
* hello
|
||||
> world
|
||||
^D
|
||||
<ul>
|
||||
<li>hello<blockquote>
|
||||
<p>world</p>
|
||||
</blockquote>
|
||||
</li>
|
||||
</ul>
|
||||
```
|
||||
|
||||
Again, which looks correct to you?
|
||||
|
||||
- - -
|
||||
|
||||
# Why quality matters - Part 2
|
||||
|
||||
``` bash
|
||||
$ markdown.pl
|
||||
* hello
|
||||
> world
|
||||
^D
|
||||
<p><ul>
|
||||
<li>hello</p>
|
||||
|
||||
<blockquote>
|
||||
<p>world</li>
|
||||
</ul></p>
|
||||
</blockquote>
|
||||
```
|
||||
|
||||
``` bash
|
||||
$ sundown # upskirt
|
||||
* hello
|
||||
> world
|
||||
^D
|
||||
<ul>
|
||||
<li>hello
|
||||
> world</li>
|
||||
</ul>
|
||||
```
|
||||
|
||||
``` bash
|
||||
$ marked
|
||||
* hello
|
||||
> world
|
||||
^D
|
||||
<ul><li>hello <blockquote><p>world</p></blockquote></li></ul>
|
||||
```
|
||||
|
||||
Which looks correct to you?
|
||||
|
||||
- - -
|
||||
|
||||
See: https://github.com/evilstreak/markdown-js/issues/23
|
||||
|
||||
``` bash
|
||||
$ markdown.pl # upskirt/markdown.js/discount
|
||||
* hello
|
||||
var a = 1;
|
||||
* world
|
||||
^D
|
||||
<ul>
|
||||
<li>hello
|
||||
var a = 1;</li>
|
||||
<li>world</li>
|
||||
</ul>
|
||||
```
|
||||
|
||||
``` bash
|
||||
$ marked
|
||||
* hello
|
||||
var a = 1;
|
||||
* world
|
||||
^D
|
||||
<ul><li>hello
|
||||
<pre>code>var a = 1;</code></pre></li>
|
||||
<li>world</li></ul>
|
||||
```
|
||||
|
||||
Which looks more reasonable? Why shouldn't code blocks be able to appear in
|
||||
list items in a sane way?
|
||||
|
||||
- - -
|
||||
|
||||
``` bash
|
||||
$ markdown.js
|
||||
<div>hello</div>
|
||||
|
||||
<span>hello</span>
|
||||
^D
|
||||
<p><div>hello</div></p>
|
||||
|
||||
<p><span>hello</span></p>
|
||||
```
|
||||
|
||||
``` bash
|
||||
$ marked
|
||||
<div>hello</div>
|
||||
|
||||
<span>hello</span>
|
||||
^D
|
||||
<div>hello</div>
|
||||
|
||||
|
||||
<p><span>hello</span>
|
||||
</p>
|
||||
```
|
||||
|
||||
- - -
|
||||
|
||||
See: https://github.com/evilstreak/markdown-js/issues/27
|
||||
|
||||
``` bash
|
||||
$ markdown.js
|
||||
[](/link)
|
||||
^D
|
||||
<p><a href="/image)](/link">](/link)
|
||||
^D
|
||||
<p><a href="/link"><img src="/image" alt="an image"></a>
|
||||
</p>
|
||||
```
|
||||
|
||||
- - -
|
||||
|
||||
See: https://github.com/evilstreak/markdown-js/issues/24
|
||||
|
||||
``` bash
|
||||
$ markdown.js
|
||||
> a
|
||||
|
||||
> b
|
||||
|
||||
> c
|
||||
^D
|
||||
<blockquote><p>a</p><p>bundefined> c</p></blockquote>
|
||||
```
|
||||
|
||||
``` bash
|
||||
$ marked
|
||||
> a
|
||||
|
||||
> b
|
||||
|
||||
> c
|
||||
^D
|
||||
<blockquote><p>a
|
||||
|
||||
</p></blockquote>
|
||||
<blockquote><p>b
|
||||
|
||||
</p></blockquote>
|
||||
<blockquote><p>c
|
||||
</p></blockquote>
|
||||
```
|
||||
|
||||
- - -
|
||||
|
||||
``` bash
|
||||
$ markdown.pl
|
||||
* hello
|
||||
* world
|
||||
how
|
||||
|
||||
are
|
||||
you
|
||||
|
||||
* today
|
||||
* hi
|
||||
^D
|
||||
<ul>
|
||||
<li><p>hello</p>
|
||||
|
||||
<ul>
|
||||
<li>world
|
||||
how</li>
|
||||
</ul>
|
||||
|
||||
<p>are
|
||||
you</p>
|
||||
|
||||
<ul>
|
||||
<li>today</li>
|
||||
</ul></li>
|
||||
<li>hi</li>
|
||||
</ul>
|
||||
```
|
||||
|
||||
``` bash
|
||||
$ marked
|
||||
* hello
|
||||
* world
|
||||
how
|
||||
|
||||
are
|
||||
you
|
||||
|
||||
* today
|
||||
* hi
|
||||
^D
|
||||
<ul>
|
||||
<li><p>hello</p>
|
||||
<ul>
|
||||
<li><p>world
|
||||
how</p>
|
||||
<p>are
|
||||
you</p>
|
||||
</li>
|
||||
<li><p>today</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>hi</li>
|
||||
</ul>
|
||||
```
|
||||
|
|
@ -0,0 +1,72 @@
|
|||
html, body {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
|
||||
color: #333;
|
||||
background-color: #fbfbfb;
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
textarea {
|
||||
font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
|
||||
font-size: 12px;
|
||||
resize: none;
|
||||
}
|
||||
|
||||
header {
|
||||
padding-top: 10px;
|
||||
display: flex;
|
||||
height: 58px;
|
||||
}
|
||||
|
||||
header h1 {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.github-ribbon {
|
||||
position: absolute;
|
||||
top: 0;
|
||||
right: 0;
|
||||
border: 0;
|
||||
z-index: 1000;
|
||||
}
|
||||
|
||||
.containers {
|
||||
display: flex;
|
||||
height: calc(100vh - 68px);
|
||||
}
|
||||
|
||||
.container {
|
||||
flex-basis: 50%;
|
||||
padding: 5px;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
height: 100%;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
.pane, .inputPane {
|
||||
margin-top: 5px;
|
||||
padding: 0.6em;
|
||||
border: 1px solid #ccc;
|
||||
overflow: auto;
|
||||
flex-grow: 1;
|
||||
flex-shrink: 1;
|
||||
}
|
||||
|
||||
#preview {
|
||||
display: flex;
|
||||
}
|
||||
|
||||
#preview iframe {
|
||||
flex-grow: 1;
|
||||
}
|
||||
|
||||
#main {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.error {
|
||||
border-color: red;
|
||||
background-color: #FEE
|
||||
}
|
||||
|
|
@ -0,0 +1,534 @@
|
|||
/* globals marked, unfetch, ES6Promise, Promise */
|
||||
|
||||
if (!window.Promise) {
|
||||
window.Promise = ES6Promise;
|
||||
}
|
||||
if (!window.fetch) {
|
||||
window.fetch = unfetch;
|
||||
}
|
||||
|
||||
onunhandledrejection = function(e) {
|
||||
throw e.reason;
|
||||
};
|
||||
|
||||
var $loadingElem = document.querySelector('#loading');
|
||||
var $mainElem = document.querySelector('#main');
|
||||
var $markdownElem = document.querySelector('#markdown');
|
||||
var $markedVerElem = document.querySelector('#markedVersion');
|
||||
var $commitVerElem = document.querySelector('#commitVersion');
|
||||
var $markedVer = document.querySelector('#markedCdn');
|
||||
var $optionsElem = document.querySelector('#options');
|
||||
var $outputTypeElem = document.querySelector('#outputType');
|
||||
var $inputTypeElem = document.querySelector('#inputType');
|
||||
var $responseTimeElem = document.querySelector('#responseTime');
|
||||
var $previewElem = document.querySelector('#preview');
|
||||
var $previewIframe = document.querySelector('#preview iframe');
|
||||
var $permalinkElem = document.querySelector('#permalink');
|
||||
var $clearElem = document.querySelector('#clear');
|
||||
var $htmlElem = document.querySelector('#html');
|
||||
var $lexerElem = document.querySelector('#lexer');
|
||||
var $panes = document.querySelectorAll('.pane');
|
||||
var $inputPanes = document.querySelectorAll('.inputPane');
|
||||
var lastInput = '';
|
||||
var inputDirty = true;
|
||||
var $activeOutputElem = null;
|
||||
var search = searchToObject();
|
||||
var markedVersions = {
|
||||
master: 'https://cdn.jsdelivr.net/gh/markedjs/marked/lib/marked.js'
|
||||
};
|
||||
var markedVersionCache = {};
|
||||
var delayTime = 1;
|
||||
var checkChangeTimeout = null;
|
||||
var markedWorker;
|
||||
|
||||
$previewIframe.addEventListener('load', handleIframeLoad);
|
||||
|
||||
$outputTypeElem.addEventListener('change', handleOutputChange, false);
|
||||
|
||||
$inputTypeElem.addEventListener('change', handleInputChange, false);
|
||||
|
||||
$markedVerElem.addEventListener('change', handleVersionChange, false);
|
||||
|
||||
$markdownElem.addEventListener('change', handleInput, false);
|
||||
$markdownElem.addEventListener('keyup', handleInput, false);
|
||||
$markdownElem.addEventListener('keypress', handleInput, false);
|
||||
$markdownElem.addEventListener('keydown', handleInput, false);
|
||||
|
||||
$optionsElem.addEventListener('change', handleInput, false);
|
||||
$optionsElem.addEventListener('keyup', handleInput, false);
|
||||
$optionsElem.addEventListener('keypress', handleInput, false);
|
||||
$optionsElem.addEventListener('keydown', handleInput, false);
|
||||
|
||||
$commitVerElem.style.display = 'none';
|
||||
$commitVerElem.addEventListener('keypress', handleAddVersion, false);
|
||||
|
||||
$clearElem.addEventListener('click', handleClearClick, false);
|
||||
|
||||
Promise.all([
|
||||
setInitialQuickref(),
|
||||
setInitialOutputType(),
|
||||
setInitialText(),
|
||||
setInitialVersion()
|
||||
.then(setInitialOptions)
|
||||
]).then(function() {
|
||||
handleInputChange();
|
||||
handleOutputChange();
|
||||
checkForChanges();
|
||||
setScrollPercent(0);
|
||||
$loadingElem.style.display = 'none';
|
||||
$mainElem.style.display = 'block';
|
||||
});
|
||||
|
||||
function setInitialText() {
|
||||
if ('text' in search) {
|
||||
$markdownElem.value = search.text;
|
||||
} else {
|
||||
return fetch('./initial.md')
|
||||
.then(function(res) { return res.text(); })
|
||||
.then(function(text) {
|
||||
if ($markdownElem.value === '') {
|
||||
$markdownElem.value = text;
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
function setInitialQuickref() {
|
||||
return fetch('./quickref.md')
|
||||
.then(function(res) { return res.text(); })
|
||||
.then(function(text) {
|
||||
document.querySelector('#quickref').value = text;
|
||||
});
|
||||
}
|
||||
|
||||
function setInitialVersion() {
|
||||
return fetch('https://data.jsdelivr.com/v1/package/npm/marked')
|
||||
.then(function(res) {
|
||||
return res.json();
|
||||
})
|
||||
.then(function(json) {
|
||||
for (var i = 0; i < json.versions.length; i++) {
|
||||
var ver = json.versions[i];
|
||||
markedVersions[ver] = 'https://cdn.jsdelivr.net/npm/marked@' + ver + '/lib/marked.js';
|
||||
var opt = document.createElement('option');
|
||||
opt.textContent = ver;
|
||||
opt.value = ver;
|
||||
$markedVerElem.appendChild(opt);
|
||||
}
|
||||
})
|
||||
.then(function() {
|
||||
return fetch('https://api.github.com/repos/markedjs/marked/commits')
|
||||
.then(function(res) {
|
||||
return res.json();
|
||||
})
|
||||
.then(function(json) {
|
||||
markedVersions['master'] = 'https://cdn.jsdelivr.net/gh/markedjs/marked@' + json[0].sha + '/lib/marked.js';
|
||||
})
|
||||
.catch(function() {
|
||||
// do nothing
|
||||
// uses url without commit
|
||||
});
|
||||
})
|
||||
.then(function() {
|
||||
if (search.version) {
|
||||
if (markedVersions[search.version]) {
|
||||
return search.version;
|
||||
} else {
|
||||
var match = search.version.match(/^(\w+):(.+)$/);
|
||||
if (match) {
|
||||
switch (match[1]) {
|
||||
case 'commit':
|
||||
addCommitVersion(search.version, match[2].substring(0, 7), match[2]);
|
||||
return search.version;
|
||||
case 'pr':
|
||||
return getPrCommit(match[2])
|
||||
.then(function(commit) {
|
||||
if (!commit) {
|
||||
return 'master';
|
||||
}
|
||||
addCommitVersion(search.version, 'PR #' + match[2], commit);
|
||||
return search.version;
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return 'master';
|
||||
})
|
||||
.then(function(version) {
|
||||
$markedVerElem.value = version;
|
||||
})
|
||||
.then(updateVersion);
|
||||
}
|
||||
|
||||
function setInitialOptions() {
|
||||
if ('options' in search) {
|
||||
$optionsElem.value = search.options;
|
||||
} else {
|
||||
setDefaultOptions();
|
||||
}
|
||||
}
|
||||
|
||||
function setInitialOutputType() {
|
||||
if (search.outputType) {
|
||||
$outputTypeElem.value = search.outputType;
|
||||
}
|
||||
}
|
||||
|
||||
function handleIframeLoad() {
|
||||
lastInput = '';
|
||||
inputDirty = true;
|
||||
}
|
||||
|
||||
function handleInput() {
|
||||
inputDirty = true;
|
||||
};
|
||||
|
||||
function handleVersionChange() {
|
||||
if ($markedVerElem.value === 'commit' || $markedVerElem.value === 'pr') {
|
||||
$commitVerElem.style.display = '';
|
||||
} else {
|
||||
$commitVerElem.style.display = 'none';
|
||||
updateVersion();
|
||||
}
|
||||
}
|
||||
|
||||
function handleClearClick() {
|
||||
$markdownElem.value = '';
|
||||
$markedVerElem.value = 'master';
|
||||
$commitVerElem.style.display = 'none';
|
||||
updateVersion().then(setDefaultOptions);
|
||||
}
|
||||
|
||||
function handleAddVersion(e) {
|
||||
if (e.which === 13) {
|
||||
switch ($markedVerElem.value) {
|
||||
case 'commit':
|
||||
var commit = $commitVerElem.value.toLowerCase();
|
||||
if (!commit.match(/^[0-9a-f]{40}$/)) {
|
||||
alert('That is not a valid commit');
|
||||
return;
|
||||
}
|
||||
addCommitVersion('commit:' + commit, commit.substring(0, 7), commit);
|
||||
$markedVerElem.value = 'commit:' + commit;
|
||||
$commitVerElem.style.display = 'none';
|
||||
$commitVerElem.value = '';
|
||||
updateVersion();
|
||||
break;
|
||||
case 'pr':
|
||||
$commitVerElem.disabled = true;
|
||||
var pr = $commitVerElem.value.replace(/\D/g, '');
|
||||
getPrCommit(pr)
|
||||
.then(function(commit) {
|
||||
$commitVerElem.disabled = false;
|
||||
if (!commit) {
|
||||
alert('That is not a valid PR');
|
||||
return;
|
||||
}
|
||||
addCommitVersion('pr:' + pr, 'PR #' + pr, commit);
|
||||
$markedVerElem.value = 'pr:' + pr;
|
||||
$commitVerElem.style.display = 'none';
|
||||
$commitVerElem.value = '';
|
||||
updateVersion();
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function handleInputChange() {
|
||||
handleChange($inputPanes, $inputTypeElem.value);
|
||||
}
|
||||
|
||||
function handleOutputChange() {
|
||||
$activeOutputElem = handleChange($panes, $outputTypeElem.value);
|
||||
updateLink();
|
||||
}
|
||||
|
||||
function handleChange(panes, visiblePane) {
|
||||
var active = null;
|
||||
for (var i = 0; i < panes.length; i++) {
|
||||
if (panes[i].id === visiblePane) {
|
||||
panes[i].style.display = '';
|
||||
active = panes[i];
|
||||
} else {
|
||||
panes[i].style.display = 'none';
|
||||
}
|
||||
}
|
||||
return active;
|
||||
};
|
||||
|
||||
function addCommitVersion(value, text, commit) {
|
||||
if (markedVersions[value]) {
|
||||
return;
|
||||
}
|
||||
markedVersions[value] = 'https://cdn.jsdelivr.net/gh/markedjs/marked@' + commit + '/lib/marked.js';
|
||||
var opt = document.createElement('option');
|
||||
opt.textContent = text;
|
||||
opt.value = value;
|
||||
$markedVerElem.insertBefore(opt, $markedVerElem.firstChild);
|
||||
}
|
||||
|
||||
function getPrCommit(pr) {
|
||||
return fetch('https://api.github.com/repos/markedjs/marked/pulls/' + pr + '/commits')
|
||||
.then(function(res) {
|
||||
return res.json();
|
||||
})
|
||||
.then(function(json) {
|
||||
return json[json.length - 1].sha;
|
||||
}).catch(function() {
|
||||
// return undefined
|
||||
});
|
||||
}
|
||||
|
||||
function setDefaultOptions() {
|
||||
if (window.Worker) {
|
||||
messageWorker({
|
||||
task: 'defaults',
|
||||
version: markedVersions[$markedVerElem.value]
|
||||
});
|
||||
} else {
|
||||
var defaults = marked.getDefaults();
|
||||
setOptions(defaults);
|
||||
}
|
||||
}
|
||||
|
||||
function setOptions(opts) {
|
||||
$optionsElem.value = JSON.stringify(
|
||||
opts,
|
||||
function(key, value) {
|
||||
if (value && typeof value === 'object' && Object.getPrototypeOf(value) !== Object.prototype) {
|
||||
return undefined;
|
||||
}
|
||||
return value;
|
||||
}, ' ');
|
||||
}
|
||||
|
||||
function searchToObject() {
|
||||
// modified from https://stackoverflow.com/a/7090123/806777
|
||||
var pairs = location.search.slice(1).split('&');
|
||||
var obj = {};
|
||||
|
||||
for (var i = 0; i < pairs.length; i++) {
|
||||
if (pairs[i] === '') {
|
||||
continue;
|
||||
}
|
||||
|
||||
var pair = pairs[i].split('=');
|
||||
|
||||
obj[decodeURIComponent(pair.shift())] = decodeURIComponent(pair.join('='));
|
||||
}
|
||||
|
||||
return obj;
|
||||
}
|
||||
|
||||
function jsonString(input) {
|
||||
var output = (input + '')
|
||||
.replace(/\n/g, '\\n')
|
||||
.replace(/\r/g, '\\r')
|
||||
.replace(/\t/g, '\\t')
|
||||
.replace(/\f/g, '\\f')
|
||||
.replace(/[\\"']/g, '\\$&')
|
||||
.replace(/\u0000/g, '\\0');
|
||||
return '"' + output + '"';
|
||||
};
|
||||
|
||||
function getScrollSize() {
|
||||
var e = $activeOutputElem;
|
||||
|
||||
return e.scrollHeight - e.clientHeight;
|
||||
};
|
||||
|
||||
function getScrollPercent() {
|
||||
var size = getScrollSize();
|
||||
|
||||
if (size <= 0) {
|
||||
return 1;
|
||||
}
|
||||
|
||||
return $activeOutputElem.scrollTop / size;
|
||||
};
|
||||
|
||||
function setScrollPercent(percent) {
|
||||
$activeOutputElem.scrollTop = percent * getScrollSize();
|
||||
};
|
||||
|
||||
function updateLink() {
|
||||
var outputType = '';
|
||||
if ($outputTypeElem.value !== 'preview') {
|
||||
outputType = 'outputType=' + $outputTypeElem.value + '&';
|
||||
}
|
||||
|
||||
$permalinkElem.href = '?' + outputType + 'text=' + encodeURIComponent($markdownElem.value)
|
||||
+ '&options=' + encodeURIComponent($optionsElem.value)
|
||||
+ '&version=' + encodeURIComponent($markedVerElem.value);
|
||||
history.replaceState('', document.title, $permalinkElem.href);
|
||||
}
|
||||
|
||||
function updateVersion() {
|
||||
if (window.Worker) {
|
||||
handleInput();
|
||||
return Promise.resolve();
|
||||
}
|
||||
var promise;
|
||||
if (markedVersionCache[$markedVerElem.value]) {
|
||||
promise = Promise.resolve(markedVersionCache[$markedVerElem.value]);
|
||||
} else {
|
||||
promise = fetch(markedVersions[$markedVerElem.value])
|
||||
.then(function(res) { return res.text(); })
|
||||
.then(function(text) {
|
||||
markedVersionCache[$markedVerElem.value] = text;
|
||||
return text;
|
||||
});
|
||||
}
|
||||
return promise.then(function(text) {
|
||||
var script = document.createElement('script');
|
||||
script.textContent = text;
|
||||
|
||||
$markedVer.parentNode.replaceChild(script, $markedVer);
|
||||
$markedVer = script;
|
||||
}).then(handleInput);
|
||||
}
|
||||
|
||||
function checkForChanges() {
|
||||
if (inputDirty && $markedVerElem.value !== 'commit' && $markedVerElem.value !== 'pr' && (typeof marked !== 'undefined' || window.Worker)) {
|
||||
inputDirty = false;
|
||||
|
||||
updateLink();
|
||||
|
||||
var options = {};
|
||||
var optionsString = $optionsElem.value || '{}';
|
||||
try {
|
||||
var newOptions = JSON.parse(optionsString);
|
||||
options = newOptions;
|
||||
$optionsElem.classList.remove('error');
|
||||
} catch (err) {
|
||||
$optionsElem.classList.add('error');
|
||||
}
|
||||
|
||||
var version = markedVersions[$markedVerElem.value];
|
||||
var markdown = $markdownElem.value;
|
||||
var hash = version + markdown + optionsString;
|
||||
if (lastInput !== hash) {
|
||||
lastInput = hash;
|
||||
if (window.Worker) {
|
||||
delayTime = 100;
|
||||
messageWorker({
|
||||
task: 'parse',
|
||||
version: version,
|
||||
markdown: markdown,
|
||||
options: options
|
||||
});
|
||||
} else {
|
||||
var startTime = new Date();
|
||||
var lexed = marked.lexer(markdown, options);
|
||||
var lexedList = [];
|
||||
for (var i = 0; i < lexed.length; i++) {
|
||||
var lexedLine = [];
|
||||
for (var j in lexed[i]) {
|
||||
lexedLine.push(j + ':' + jsonString(lexed[i][j]));
|
||||
}
|
||||
lexedList.push('{' + lexedLine.join(', ') + '}');
|
||||
}
|
||||
var parsed = marked.parser(lexed, options);
|
||||
var scrollPercent = getScrollPercent();
|
||||
setParsed(parsed, lexedList.join('\n'));
|
||||
setScrollPercent(scrollPercent);
|
||||
var endTime = new Date();
|
||||
delayTime = endTime - startTime;
|
||||
setResponseTime(delayTime);
|
||||
if (delayTime < 50) {
|
||||
delayTime = 50;
|
||||
} else if (delayTime > 500) {
|
||||
delayTime = 1000;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
checkChangeTimeout = window.setTimeout(checkForChanges, delayTime);
|
||||
};
|
||||
|
||||
function setResponseTime(ms) {
|
||||
var amount = ms;
|
||||
var suffix = 'ms';
|
||||
if (ms > 1000 * 60 * 60) {
|
||||
amount = 'Too Long';
|
||||
suffix = '';
|
||||
} else if (ms > 1000 * 60) {
|
||||
amount = '>' + Math.floor(ms / (1000 * 60));
|
||||
suffix = 'm';
|
||||
} else if (ms > 1000) {
|
||||
amount = '>' + Math.floor(ms / 1000);
|
||||
suffix = 's';
|
||||
}
|
||||
$responseTimeElem.textContent = amount + suffix;
|
||||
}
|
||||
|
||||
function setParsed(parsed, lexed) {
|
||||
try {
|
||||
$previewIframe.contentDocument.body.innerHTML = parsed;
|
||||
} catch (ex) {}
|
||||
$htmlElem.value = parsed;
|
||||
$lexerElem.value = lexed;
|
||||
}
|
||||
|
||||
function messageWorker(message) {
|
||||
if (!markedWorker || markedWorker.working) {
|
||||
if (markedWorker) {
|
||||
clearTimeout(markedWorker.timeout);
|
||||
markedWorker.terminate();
|
||||
}
|
||||
markedWorker = new Worker('worker.js');
|
||||
markedWorker.onmessage = function(e) {
|
||||
clearTimeout(markedWorker.timeout);
|
||||
markedWorker.working = false;
|
||||
switch (e.data.task) {
|
||||
case 'defaults':
|
||||
setOptions(e.data.defaults);
|
||||
break;
|
||||
case 'parse':
|
||||
$previewElem.classList.remove('error');
|
||||
$htmlElem.classList.remove('error');
|
||||
$lexerElem.classList.remove('error');
|
||||
var scrollPercent = getScrollPercent();
|
||||
setParsed(e.data.parsed, e.data.lexed);
|
||||
setScrollPercent(scrollPercent);
|
||||
setResponseTime(e.data.time);
|
||||
break;
|
||||
}
|
||||
clearTimeout(checkChangeTimeout);
|
||||
delayTime = 10;
|
||||
checkForChanges();
|
||||
};
|
||||
markedWorker.onerror = markedWorker.onmessageerror = function(err) {
|
||||
clearTimeout(markedWorker.timeout);
|
||||
var error = 'There was an error in the Worker';
|
||||
if (err) {
|
||||
if (err.message) {
|
||||
error = err.message;
|
||||
} else {
|
||||
error = err;
|
||||
}
|
||||
}
|
||||
error = error.replace(/^Uncaught Error: /, '');
|
||||
$previewElem.classList.add('error');
|
||||
$htmlElem.classList.add('error');
|
||||
$lexerElem.classList.add('error');
|
||||
setParsed(error, error);
|
||||
setScrollPercent(0);
|
||||
};
|
||||
}
|
||||
if (message.task !== 'defaults') {
|
||||
markedWorker.working = true;
|
||||
workerTimeout(0);
|
||||
}
|
||||
markedWorker.postMessage(message);
|
||||
}
|
||||
|
||||
function workerTimeout(seconds) {
|
||||
markedWorker.timeout = setTimeout(function() {
|
||||
seconds++;
|
||||
markedWorker.onerror('Marked has taken longer than ' + seconds + ' second' + (seconds > 1 ? 's' : '') + ' to respond...');
|
||||
workerTimeout(seconds);
|
||||
}, 1000);
|
||||
}
|
||||
|
|
@ -0,0 +1,78 @@
|
|||
<!doctype html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<title>Marked Demo</title>
|
||||
<link rel="stylesheet" href="./demo.css" type="text/css" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<a href="https://github.com/markedjs/marked">
|
||||
<img class="github-ribbon" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub">
|
||||
</a>
|
||||
|
||||
<header>
|
||||
<a href="../">
|
||||
<img src="../img/logo-black.svg" height="64px" width="64px" />
|
||||
</a>
|
||||
<h1>Marked Demo</h1>
|
||||
</header>
|
||||
|
||||
<div id="loading">Loading...</div>
|
||||
<div id="main">
|
||||
<div class="containers">
|
||||
<div class="container">
|
||||
<div class="label">
|
||||
<span>Input</span> ·
|
||||
<a id="permalink">Permalink</a> ·
|
||||
<span>Version: </span>
|
||||
<select id="markedVersion">
|
||||
<option value="pr">Add PR:</option>
|
||||
<option value="commit">Add Commit:</option>
|
||||
<option value="master" selected>master</option>
|
||||
</select>
|
||||
<input type="text" id="commitVersion" title="Press ENTER to add commit" />·
|
||||
<button id="clear">Clear</button>
|
||||
<select id="inputType">
|
||||
<option value="markdown">Markdown</option>
|
||||
<option value="options">Options</option>
|
||||
</select>
|
||||
</div>
|
||||
<textarea id="markdown" class="inputPane"></textarea>
|
||||
<textarea id="options" class="inputPane" placeholder="Options (as JSON)"></textarea>
|
||||
</div>
|
||||
|
||||
<div class="container">
|
||||
<div class="label">
|
||||
<select id="outputType">
|
||||
<option value="preview">Preview</option>
|
||||
<option value="html">HTML Source</option>
|
||||
<option value="lexer">Lexer Data</option>
|
||||
<option value="quickref">Quick Reference</option>
|
||||
</select> ·
|
||||
Response Time:
|
||||
<span id="responseTime"></span>
|
||||
</div>
|
||||
|
||||
<div id="preview" class="pane">
|
||||
<noscript>
|
||||
<h2>You'll need to enable Javascript to use this tool.</h2>
|
||||
</noscript>
|
||||
<iframe src="./preview.html" frameborder="0" sandbox="allow-same-origin allow-top-navigation-by-user-activation"></iframe>
|
||||
</div>
|
||||
|
||||
<textarea id="html" class="pane" readonly="readonly"></textarea>
|
||||
|
||||
<textarea id="lexer" class="pane" readonly="readonly"></textarea>
|
||||
|
||||
<textarea id="quickref" class="pane" readonly="readonly"></textarea>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<script id="markedCdn"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/es6-promise/dist/es6-promise.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/unfetch/dist/unfetch.umd.js"></script>
|
||||
<script src="./demo.js"></script>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
Marked - Markdown Parser
|
||||
========================
|
||||
|
||||
[Marked] lets you convert [Markdown] into HTML. Markdown is a simple text format whose goal is to be very easy to read and write, even when not converted to HTML. This demo page will let you type anything you like and see how it gets converted. Live. No more waiting around.
|
||||
|
||||
How To Use The Demo
|
||||
-------------------
|
||||
|
||||
1. Type in stuff on the left.
|
||||
2. See the live updates on the right.
|
||||
|
||||
That's it. Pretty simple. There's also a drop-down option in the upper right to switch between various views:
|
||||
|
||||
- **Preview:** A live display of the generated HTML as it would render in a browser.
|
||||
- **HTML Source:** The generated HTML before your browser makes it pretty.
|
||||
- **Lexer Data:** What [marked] uses internally, in case you like gory stuff like this.
|
||||
- **Quick Reference:** A brief run-down of how to format things using markdown.
|
||||
|
||||
Why Markdown?
|
||||
-------------
|
||||
|
||||
It's easy. It's not overly bloated, unlike HTML. Also, as the creator of [markdown] says,
|
||||
|
||||
> The overriding design goal for Markdown's
|
||||
> formatting syntax is to make it as readable
|
||||
> as possible. The idea is that a
|
||||
> Markdown-formatted document should be
|
||||
> publishable as-is, as plain text, without
|
||||
> looking like it's been marked up with tags
|
||||
> or formatting instructions.
|
||||
|
||||
Ready to start writing? Either start changing stuff on the left or
|
||||
[clear everything](/demo/?text=) with a simple click.
|
||||
|
||||
[Marked]: https://github.com/markedjs/marked/
|
||||
[Markdown]: http://daringfireball.net/projects/markdown/
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>marked.js preview</title>
|
||||
<link rel="stylesheet" href="./demo.css" />
|
||||
<base target="_parent">
|
||||
</head>
|
||||
<body>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,167 @@
|
|||
Markdown Quick Reference
|
||||
========================
|
||||
|
||||
This guide is a very brief overview, with examples, of the syntax that [Markdown] supports. It is itself written in Markdown and you can copy the samples over to the left-hand pane for experimentation. It's shown as *text* and not *rendered HTML*.
|
||||
|
||||
[Markdown]: http://daringfireball.net/projects/markdown/
|
||||
|
||||
|
||||
Simple Text Formatting
|
||||
======================
|
||||
|
||||
First thing is first. You can use *stars* or _underscores_ for italics. **Double stars** and __double underscores__ do bold. ***Three together*** do ___both___.
|
||||
|
||||
Paragraphs are pretty easy too. Just have a blank line between chunks of text.
|
||||
|
||||
> This chunk of text is in a block quote. Its multiple lines will all be
|
||||
> indended a bit from the rest of the text.
|
||||
>
|
||||
> > Multiple levels of block quotes also work.
|
||||
|
||||
Sometimes you want to include some code, such as when you are explaining how `<h1>` HTML tags work, or maybe you are a programmer and you are discussing `someMethod()`.
|
||||
|
||||
If you want to include some code and have
|
||||
newlines preserved, indent the line with a tab
|
||||
or at least four spaces.
|
||||
Extra spaces work here too.
|
||||
This is also called preformatted text and it is useful for showing examples.
|
||||
The text will stay as text, so any *markdown* or <u>HTML</u> you add will
|
||||
not show up formatted. This way you can show markdown examples in a
|
||||
markdown document.
|
||||
|
||||
> You can also use preformatted text with your blockquotes
|
||||
> as long as you add at least five spaces.
|
||||
|
||||
|
||||
Headings
|
||||
========
|
||||
|
||||
There are a couple of ways to make headings. Using three or more equals signs on a line under a heading makes it into an "h1" style. Three or more hyphens under a line makes it "h2" (slightly smaller). You can also use multiple pound symbols before and after a heading. Pounds after the title are ignored. Here's some examples:
|
||||
|
||||
This is H1
|
||||
==========
|
||||
|
||||
This is H2
|
||||
----------
|
||||
|
||||
# This is H1
|
||||
## This is H2
|
||||
### This is H3 with some extra pounds ###
|
||||
#### You get the idea ####
|
||||
##### I don't need extra pounds at the end
|
||||
###### H6 is the max
|
||||
|
||||
|
||||
Links
|
||||
=====
|
||||
|
||||
Let's link to a few sites. First, let's use the bare URL, like <http://www.github.com>. Great for text, but ugly for HTML.
|
||||
Next is an inline link to [Google](http://www.google.com). A little nicer.
|
||||
This is a reference-style link to [Wikipedia] [1].
|
||||
Lastly, here's a pretty link to [Yahoo]. The reference-style and pretty links both automatically use the links defined below, but they could be defined *anywhere* in the markdown and are removed from the HTML. The names are also case insensitive, so you can use [YaHoO] and have it link properly.
|
||||
|
||||
[1]: http://www.wikipedia.org/
|
||||
[Yahoo]: http://www.yahoo.com/
|
||||
|
||||
Title attributes may be added to links by adding text after a link.
|
||||
This is the [inline link](http://www.bing.com "Bing") with a "Bing" title.
|
||||
You can also go to [W3C] [2] and maybe visit a [friend].
|
||||
|
||||
[2]: http://w3c.org (The W3C puts out specs for web-based things)
|
||||
[Friend]: http://facebook.com/ "Facebook!"
|
||||
|
||||
Email addresses in plain text are not linked: test@example.com.
|
||||
Email addresses wrapped in angle brackets are linked: <test@example.com>.
|
||||
They are also obfuscated so that email harvesting spam robots hopefully won't get them.
|
||||
|
||||
|
||||
Lists
|
||||
=====
|
||||
|
||||
* This is a bulleted list
|
||||
* Great for shopping lists
|
||||
- You can also use hyphens
|
||||
+ Or plus symbols
|
||||
|
||||
The above is an "unordered" list. Now, on for a bit of order.
|
||||
|
||||
1. Numbered lists are also easy
|
||||
2. Just start with a number
|
||||
3738762. However, the actual number doesn't matter when converted to HTML.
|
||||
1. This will still show up as 4.
|
||||
|
||||
You might want a few advanced lists:
|
||||
|
||||
- This top-level list is wrapped in paragraph tags
|
||||
- This generates an extra space between each top-level item.
|
||||
|
||||
- You do it by adding a blank line
|
||||
|
||||
- This nested list also has blank lines between the list items.
|
||||
|
||||
- How to create nested lists
|
||||
1. Start your regular list
|
||||
2. Indent nested lists with four spaces
|
||||
3. Further nesting means you should indent with four more spaces
|
||||
* This line is indented with eight spaces.
|
||||
|
||||
- List items can be quite lengthy. You can keep typing and either continue
|
||||
them on the next line with no indentation.
|
||||
|
||||
- Alternately, if that looks ugly, you can also
|
||||
indent the next line a bit for a prettier look.
|
||||
|
||||
- You can put large blocks of text in your list by just indenting with four spaces.
|
||||
|
||||
This is formatted the same as code, but you can inspect the HTML
|
||||
and find that it's just wrapped in a `<p>` tag and *won't* be shown
|
||||
as preformatted text.
|
||||
|
||||
You can keep adding more and more paragraphs to a single
|
||||
list item by adding the traditional blank line and then keep
|
||||
on indenting the paragraphs with four spaces. You really need
|
||||
to only indent the first line, but that looks ugly.
|
||||
|
||||
- Lists support blockquotes
|
||||
|
||||
> Just like this example here. By the way, you can
|
||||
> nest lists inside blockquotes!
|
||||
> - Fantastic!
|
||||
|
||||
- Lists support preformatted text
|
||||
|
||||
You just need to indent eight spaces.
|
||||
|
||||
|
||||
Even More
|
||||
=========
|
||||
|
||||
Horizontal Rule
|
||||
---------------
|
||||
|
||||
If you need a horizontal rule you just need to put at least three hyphens, asterisks, or underscores on a line by themselves. You can also even put spaces between the characters.
|
||||
|
||||
---
|
||||
****************************
|
||||
_ _ _ _ _ _ _
|
||||
|
||||
Those three all produced horizontal lines. Keep in mind that three hyphens under any text turns that text into a heading, so add a blank like if you use hyphens.
|
||||
|
||||
Images
|
||||
------
|
||||
|
||||
Images work exactly like links, but they have exclamation points in front. They work with references and titles too.
|
||||
|
||||
 and ![Happy].
|
||||
|
||||
[Happy]: http://www.wpclipart.com/smiley/simple_smiley/smiley_face_simple_green_small.png ("Smiley face")
|
||||
|
||||
|
||||
Inline HTML
|
||||
-----------
|
||||
|
||||
If markdown is too limiting, you can just insert your own <strike>crazy</strike> HTML. Span-level HTML <u>can *still* use markdown</u>. Block level elements must be separated from text by a blank line and must not have any spaces before the opening and closing HTML.
|
||||
|
||||
<div style='font-family: "Comic Sans", sans-serif;'>
|
||||
It is a pity, but markdown does **not** work in here for most markdown parsers. [Marked] handles it pretty well.
|
||||
</div>
|
||||
|
|
@ -0,0 +1,105 @@
|
|||
/* globals marked, unfetch, ES6Promise, Promise */
|
||||
if (!self.Promise) {
|
||||
self.importScripts('https://cdn.jsdelivr.net/npm/es6-promise/dist/es6-promise.js');
|
||||
self.Promise = ES6Promise;
|
||||
}
|
||||
if (!self.fetch) {
|
||||
self.importScripts('https://cdn.jsdelivr.net/npm/unfetch/dist/unfetch.umd.js');
|
||||
self.fetch = unfetch;
|
||||
}
|
||||
|
||||
var versionCache = {};
|
||||
var currentVersion;
|
||||
|
||||
onunhandledrejection = function(e) {
|
||||
throw e.reason;
|
||||
};
|
||||
|
||||
onmessage = function(e) {
|
||||
if (e.data.version === currentVersion) {
|
||||
parse(e);
|
||||
} else {
|
||||
loadVersion(e.data.version).then(function() {
|
||||
parse(e);
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
function parse(e) {
|
||||
switch (e.data.task) {
|
||||
case 'defaults':
|
||||
|
||||
var defaults = {};
|
||||
if (typeof marked.getDefaults === 'function') {
|
||||
defaults = marked.getDefaults();
|
||||
delete defaults.renderer;
|
||||
} else if ('defaults' in marked) {
|
||||
for (var prop in marked.defaults) {
|
||||
if (prop !== 'renderer') {
|
||||
defaults[prop] = marked.defaults[prop];
|
||||
}
|
||||
}
|
||||
}
|
||||
postMessage({
|
||||
task: e.data.task,
|
||||
defaults: defaults
|
||||
});
|
||||
break;
|
||||
case 'parse':
|
||||
var startTime = new Date();
|
||||
var lexed = marked.lexer(e.data.markdown, e.data.options);
|
||||
var lexedList = [];
|
||||
for (var i = 0; i < lexed.length; i++) {
|
||||
var lexedLine = [];
|
||||
for (var j in lexed[i]) {
|
||||
lexedLine.push(j + ':' + jsonString(lexed[i][j]));
|
||||
}
|
||||
lexedList.push('{' + lexedLine.join(', ') + '}');
|
||||
}
|
||||
var parsed = marked.parser(lexed, e.data.options);
|
||||
var endTime = new Date();
|
||||
// setTimeout(function () {
|
||||
postMessage({
|
||||
task: e.data.task,
|
||||
lexed: lexedList.join('\n'),
|
||||
parsed: parsed,
|
||||
time: endTime - startTime
|
||||
});
|
||||
// }, 10000);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
function jsonString(input) {
|
||||
var output = (input + '')
|
||||
.replace(/\n/g, '\\n')
|
||||
.replace(/\r/g, '\\r')
|
||||
.replace(/\t/g, '\\t')
|
||||
.replace(/\f/g, '\\f')
|
||||
.replace(/[\\"']/g, '\\$&')
|
||||
.replace(/\u0000/g, '\\0');
|
||||
return '"' + output + '"';
|
||||
};
|
||||
|
||||
function loadVersion(ver) {
|
||||
var promise;
|
||||
if (versionCache[ver]) {
|
||||
promise = Promise.resolve(versionCache[ver]);
|
||||
} else {
|
||||
promise = fetch(ver)
|
||||
.then(function(res) { return res.text(); })
|
||||
.then(function(text) {
|
||||
versionCache[ver] = text;
|
||||
return text;
|
||||
});
|
||||
}
|
||||
return promise.then(function(text) {
|
||||
try {
|
||||
// eslint-disable-next-line no-new-func
|
||||
Function(text)();
|
||||
} catch (err) {
|
||||
throw new Error('Cannot load that version of marked');
|
||||
}
|
||||
currentVersion = ver;
|
||||
});
|
||||
}
|
||||
|
|
@ -0,0 +1,133 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- Generator: Adobe Illustrator 16.0.4, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
|
||||
width="996px" height="439.589px" viewBox="0 0 996 439.589" enable-background="new 0 0 996 439.589" xml:space="preserve">
|
||||
<g>
|
||||
<g id="Marked_Letters">
|
||||
<path fill="#010101" d="M185.044,358.869h-9.961l-1.143-25.986l-14.092,25.986h-6.24l-6.709-26.807l-8.818,26.807h-10.225
|
||||
l13.389-40.605h10.928l6.416,25.781l13.916-25.781h10.635L185.044,358.869z"/>
|
||||
<path fill="#010101" d="M226.617,358.869h-10.811l-1.084-8.994H202.33l-4.102,8.994h-10.605l20.566-40.605h10.986L226.617,358.869
|
||||
z M214.019,344.162l-1.934-15.527l-7.061,15.527H214.019z"/>
|
||||
<path fill="#010101" d="M267.712,358.869h-11.338l-4.043-8.467c-1.191-2.559-2.227-4.478-3.105-5.757s-1.651-2.07-2.314-2.373
|
||||
c-0.664-0.303-1.553-0.454-2.666-0.454h-1.553l-2.578,17.051h-10.283l5.889-40.605h15.85c5.761,0,9.672,1.27,11.733,3.809
|
||||
c2.061,2.539,3.091,5.283,3.091,8.232c0,3.105-0.854,5.522-2.563,7.251c-1.709,1.729-4.097,2.798-7.163,3.208
|
||||
c1.562,0.898,2.769,1.953,3.618,3.164s1.86,3.096,3.032,5.654L267.712,358.869z M255.525,330.012c0-1.562-0.571-2.925-1.714-4.087
|
||||
s-3.453-1.743-6.929-1.743h-1.611l-1.699,11.719h4.102c2.89,0,4.922-0.61,6.094-1.831S255.525,331.496,255.525,330.012z"/>
|
||||
<path fill="#010101" d="M313.705,318.264l-17.578,18.223l14.912,22.383h-11.807l-14.59-21.65l-3.282,21.65h-10.342l6.064-40.605
|
||||
h10.401l-2.578,17.256l16.611-17.256H313.705z"/>
|
||||
<path fill="#010101" d="M346.426,318.264L345.4,325.5h-16.436l-1.26,8.818h14.268l-1.025,7.266h-14.385l-1.377,10.02h19.98
|
||||
l-1.025,7.266h-30.439l5.889-40.605H346.426z"/>
|
||||
<path fill="#010101" d="M389.953,338.156c0,4.512-0.86,8.301-2.578,11.367c-1.719,3.066-4.273,5.391-7.662,6.973
|
||||
s-7.583,2.373-12.582,2.373H348.41l5.83-40.605h14.941c3.534,0,6.625,0.527,9.271,1.582s4.82,2.51,6.52,4.365
|
||||
s2.953,3.97,3.764,6.343S389.953,335.461,389.953,338.156z M379.377,338.303c0-2.031-0.387-4.004-1.158-5.918
|
||||
s-2.192-3.54-4.262-4.878c-2.07-1.338-4.941-2.007-8.613-2.007h-1.67l-3.779,26.104h5.449c2.597,0,4.828-0.391,6.693-1.172
|
||||
s3.33-1.821,4.395-3.12s1.821-2.71,2.271-4.233C379.152,341.555,379.377,339.963,379.377,338.303z"/>
|
||||
</g>
|
||||
<g>
|
||||
<path fill="#010101" d="M406.922,307.149l-3.703,26.35c-0.609,4.324-2.72,6.486-6.33,6.486c-0.773,0-1.553-0.07-2.338-0.211
|
||||
l-0.756-3.023c0.879,0.188,1.67,0.281,2.373,0.281c1.219,0,2.118-0.302,2.698-0.905s0.964-1.55,1.151-2.839l3.674-26.139H406.922z
|
||||
"/>
|
||||
<path fill="#010101" d="M423.027,307.8l-0.475,3.357c-1.312-0.867-2.748-1.301-4.307-1.301c-1.312,0-2.361,0.34-3.146,1.02
|
||||
s-1.178,1.576-1.178,2.689c0,0.551,0.188,1.131,0.562,1.74s1.471,1.644,3.287,3.103s3.015,2.739,3.595,3.841
|
||||
s0.87,2.203,0.87,3.305c0,1.758-0.662,3.275-1.986,4.553s-3.088,1.916-5.291,1.916c-1.957,0-3.938-0.586-5.941-1.758l0.51-3.604
|
||||
c2.238,1.559,4.16,2.338,5.766,2.338c0.867,0,1.69-0.284,2.47-0.852c0.779-0.568,1.169-1.339,1.169-2.312
|
||||
c0-0.62-0.197-1.265-0.59-1.933c-0.394-0.667-1.502-1.745-3.324-3.232c-1.824-1.486-3.014-2.778-3.568-3.874
|
||||
c-0.555-1.097-0.832-2.185-0.832-3.263c0-1.899,0.785-3.491,2.355-4.775c1.57-1.283,3.422-1.926,5.555-1.926
|
||||
C420.016,306.833,421.516,307.155,423.027,307.8z"/>
|
||||
</g>
|
||||
<g>
|
||||
<g>
|
||||
<path fill="#010101" d="M357,200v-92c0-8.284-6.716-15-15-15H172c-8.284,0-15,6.716-15,15v92H357z"/>
|
||||
<path fill="#010101" d="M157,205v73c0,8.284,6.716,15,15,15h170c8.284,0,15-6.716,15-15v-73H157z"/>
|
||||
</g>
|
||||
<g>
|
||||
<path fill="#FFFFFF" d="M208.737,180.15v-33.125l16.987,21.234l16.987-21.234v33.125h16.987v-57.756h-16.987l-16.987,21.234
|
||||
l-16.987-21.234H191.75v57.756H208.737z"/>
|
||||
<path fill="#FFFFFF" d="M322.55,151.272h-16.987v-28.878h-16.986v28.878h-16.987L297.069,181L322.55,151.272z"/>
|
||||
</g>
|
||||
<g>
|
||||
<path fill="#FFFFFF" d="M217,241.154c0,2.124-1.722,3.846-3.845,3.846h-5.31c-2.124,0-3.845-1.722-3.845-3.846v-0.309
|
||||
c0-2.124,1.722-3.846,3.845-3.846h5.31c2.124,0,3.845,1.722,3.845,3.846V241.154z"/>
|
||||
<path fill="#FFFFFF" d="M207.859,256.5c0,1.933-1.1,3.5-2.457,3.5h-12.046c-1.357,0-2.457-1.567-2.457-3.5l0,0
|
||||
c0-1.933,1.1-3.5,2.457-3.5h12.046C206.759,253,207.859,254.567,207.859,256.5L207.859,256.5z"/>
|
||||
<path fill="#FFFFFF" d="M328.044,238.021c-1.058-3.094-2.692-5.85-4.907-8.269c-2.215-2.418-5.049-4.314-8.498-5.689
|
||||
c-3.45-1.375-7.479-2.063-12.086-2.063h-19.477l-7.6,52.932h24.403c6.518,0,11.984-1.032,16.402-3.094
|
||||
c4.416-2.062,7.746-5.092,9.986-9.09c2.24-3.996,3.361-8.936,3.361-14.817C329.629,244.418,329.1,241.115,328.044,238.021z
|
||||
M314.964,254.347c-0.586,1.986-1.573,3.826-2.96,5.519c-1.389,1.694-3.297,3.049-5.729,4.067s-5.34,1.528-8.727,1.528h-7.103
|
||||
l4.927-34.027h2.176c4.787,0,8.529,0.872,11.229,2.616c2.698,1.744,4.55,3.863,5.557,6.358c1.005,2.494,1.508,5.066,1.508,7.713
|
||||
C315.842,250.286,315.549,252.361,314.964,254.347z"/>
|
||||
<path fill="#FFFFFF" d="M246.148,241.043l1.373-9.61h21.424l1.336-9.434h-10.601h-24.38h-1.256c-2.125,0-3.846,1.877-3.846,4
|
||||
s1.721,4,3.846,4h0.096h3.793c1.928,0,3.491,1.563,3.491,3.491c0,1.928-1.563,3.491-3.491,3.491h-4.806L233.126,237h-8.983
|
||||
c-1.299,0-2.353,1.786-2.353,3.988c0,2.203,1.053,3.989,2.353,3.989h7.826L231.966,245h3.189c2.124,0,3.845,1.722,3.845,3.846
|
||||
v0.309c0,2.124-1.722,3.846-3.845,3.846h-4.349h-0.96H216.2c-1.933,0-3.5,1.567-3.5,3.5s1.567,3.5,3.5,3.5h8.645h4.945h0.364
|
||||
c2.124,0,3.845,1.722,3.845,3.846v0.309c0,2.124-1.722,3.846-3.845,3.846h-1.524h-3.785h-1.8c-2.125,0-3.846,1.377-3.846,3.5
|
||||
s1.721,3.5,3.846,3.5h25.636c0.273,0,0.538-0.024,0.795-0.068h17.828l1.336-9.471h-26.045l1.795-13.062h18.751l1.336-9.471
|
||||
h-18.598l0.029-0.205C246.055,242.213,246.144,241.647,246.148,241.043z"/>
|
||||
</g>
|
||||
</g>
|
||||
</g>
|
||||
<g>
|
||||
<g id="Marked_Letters_1_">
|
||||
<path fill="#010101" d="M619.045,356.869h-9.961l-1.143-25.986l-14.092,25.986h-6.24l-6.709-26.807l-8.818,26.807h-10.225
|
||||
l13.389-40.605h10.928l6.416,25.781l13.916-25.781h10.635L619.045,356.869z"/>
|
||||
<path fill="#010101" d="M660.617,356.869h-10.811l-1.084-8.994H636.33l-4.102,8.994h-10.605l20.566-40.605h10.986L660.617,356.869
|
||||
z M648.02,342.162l-1.934-15.527l-7.061,15.527H648.02z"/>
|
||||
<path fill="#010101" d="M701.713,356.869h-11.338l-4.043-8.467c-1.191-2.559-2.227-4.478-3.105-5.757s-1.651-2.07-2.314-2.373
|
||||
c-0.664-0.303-1.553-0.454-2.666-0.454h-1.553l-2.578,17.051h-10.283l5.889-40.605h15.85c5.761,0,9.672,1.27,11.732,3.809
|
||||
s3.092,5.283,3.092,8.232c0,3.105-0.855,5.522-2.564,7.251s-4.097,2.798-7.162,3.208c1.562,0.898,2.768,1.953,3.617,3.164
|
||||
s1.861,3.096,3.033,5.654L701.713,356.869z M689.525,328.012c0-1.562-0.572-2.925-1.715-4.087s-3.452-1.743-6.928-1.743h-1.611
|
||||
l-1.699,11.719h4.102c2.89,0,4.922-0.61,6.094-1.831S689.525,329.496,689.525,328.012z"/>
|
||||
<path fill="#010101" d="M747.705,316.264l-17.578,18.223l14.912,22.383h-11.807l-14.59-21.65l-3.281,21.65H705.02l6.064-40.605
|
||||
h10.4l-2.578,17.256l16.611-17.256H747.705z"/>
|
||||
<path fill="#010101" d="M780.426,316.264L779.4,323.5h-16.436l-1.26,8.818h14.268l-1.025,7.266h-14.385l-1.377,10.02h19.98
|
||||
l-1.025,7.266h-30.439l5.889-40.605H780.426z"/>
|
||||
<path fill="#010101" d="M823.953,336.156c0,4.512-0.86,8.301-2.578,11.367c-1.719,3.066-4.273,5.391-7.662,6.973
|
||||
s-7.583,2.373-12.582,2.373H782.41l5.83-40.605h14.941c3.534,0,6.625,0.527,9.271,1.582s4.82,2.51,6.52,4.365
|
||||
s2.953,3.97,3.764,6.343S823.953,333.461,823.953,336.156z M813.377,336.303c0-2.031-0.387-4.004-1.158-5.918
|
||||
s-2.192-3.54-4.262-4.878c-2.07-1.338-4.941-2.007-8.613-2.007h-1.67l-3.779,26.104h5.449c2.597,0,4.828-0.391,6.693-1.172
|
||||
s3.33-1.821,4.395-3.12s1.821-2.71,2.271-4.233C813.152,339.555,813.377,337.963,813.377,336.303z"/>
|
||||
</g>
|
||||
<g>
|
||||
<path fill="#010101" d="M840.922,305.149l-3.703,26.35c-0.609,4.324-2.72,6.486-6.33,6.486c-0.773,0-1.553-0.07-2.338-0.211
|
||||
l-0.756-3.023c0.879,0.188,1.67,0.281,2.373,0.281c1.219,0,2.118-0.302,2.698-0.905s0.964-1.55,1.151-2.839l3.674-26.139H840.922z
|
||||
"/>
|
||||
<path fill="#010101" d="M857.027,305.8l-0.475,3.357c-1.312-0.867-2.748-1.301-4.307-1.301c-1.312,0-2.361,0.34-3.146,1.02
|
||||
s-1.178,1.576-1.178,2.689c0,0.551,0.188,1.131,0.562,1.74s1.471,1.644,3.287,3.103s3.015,2.739,3.595,3.841
|
||||
s0.87,2.203,0.87,3.305c0,1.758-0.662,3.275-1.986,4.553s-3.088,1.916-5.291,1.916c-1.957,0-3.938-0.586-5.941-1.758l0.51-3.604
|
||||
c2.238,1.559,4.16,2.338,5.766,2.338c0.867,0,1.69-0.284,2.47-0.852c0.779-0.568,1.169-1.339,1.169-2.312
|
||||
c0-0.62-0.197-1.265-0.59-1.933c-0.394-0.667-1.502-1.745-3.324-3.232c-1.824-1.486-3.014-2.778-3.568-3.874
|
||||
c-0.555-1.097-0.832-2.185-0.832-3.263c0-1.899,0.785-3.491,2.355-4.775c1.57-1.283,3.422-1.926,5.555-1.926
|
||||
C854.016,304.833,855.516,305.155,857.027,305.8z"/>
|
||||
</g>
|
||||
<g>
|
||||
<g>
|
||||
<path d="M641,234.154c0,2.124-1.722,3.846-3.846,3.846h-5.309c-2.124,0-3.846-1.722-3.846-3.846v-0.309
|
||||
c0-2.124,1.722-3.846,3.846-3.846h5.309c2.124,0,3.846,1.722,3.846,3.846V234.154z"/>
|
||||
<path d="M631.859,249.5c0,1.933-1.1,3.5-2.457,3.5h-12.046c-1.356,0-2.456-1.567-2.456-3.5l0,0c0-1.933,1.1-3.5,2.456-3.5h12.046
|
||||
C630.76,246,631.859,247.567,631.859,249.5L631.859,249.5z"/>
|
||||
<path d="M752.044,231.021c-1.058-3.094-2.692-5.85-4.907-8.269c-2.215-2.418-5.049-4.314-8.498-5.689
|
||||
c-3.45-1.375-7.479-2.063-12.086-2.063h-19.477l-7.6,52.932h24.402c6.518,0,11.984-1.032,16.402-3.094
|
||||
c4.416-2.062,7.746-5.092,9.986-9.09c2.24-3.996,3.361-8.936,3.361-14.817C753.629,237.418,753.1,234.115,752.044,231.021z
|
||||
M738.964,247.347c-0.586,1.986-1.573,3.826-2.96,5.519c-1.389,1.694-3.297,3.049-5.729,4.067s-5.34,1.528-8.727,1.528h-7.103
|
||||
l4.927-34.027h2.176c4.787,0,8.529,0.872,11.229,2.616c2.698,1.744,4.55,3.863,5.557,6.358c1.005,2.494,1.508,5.066,1.508,7.713
|
||||
C739.842,243.286,739.549,245.361,738.964,247.347z"/>
|
||||
<path d="M670.148,234.043l1.373-9.61h21.424l1.337-9.434h-10.601h-24.381h-1.256c-2.124,0-3.846,1.877-3.846,4s1.722,4,3.846,4
|
||||
h0.096h3.793c1.929,0,3.492,1.563,3.492,3.491c0,1.928-1.563,3.491-3.492,3.491h-4.805L657.126,230h-8.983
|
||||
c-1.299,0-2.352,1.786-2.352,3.988c0,2.203,1.053,3.989,2.352,3.989h7.826L655.966,238h3.188c2.124,0,3.846,1.722,3.846,3.846
|
||||
v0.309c0,2.124-1.722,3.846-3.846,3.846h-4.349h-0.96H640.2c-1.933,0-3.5,1.567-3.5,3.5s1.567,3.5,3.5,3.5h8.646h4.945h0.363
|
||||
c2.124,0,3.846,1.722,3.846,3.846v0.309c0,2.124-1.722,3.846-3.846,3.846h-1.523h-3.785h-1.801c-2.124,0-3.846,1.377-3.846,3.5
|
||||
s1.722,3.5,3.846,3.5h25.637c0.272,0,0.537-0.024,0.795-0.068h17.827l1.337-9.471h-26.045l1.795-13.062h18.75l1.337-9.471
|
||||
h-18.599l0.029-0.205C670.055,235.213,670.144,234.647,670.148,234.043z"/>
|
||||
</g>
|
||||
<g>
|
||||
<path fill="#010101" d="M642.236,179.15v-33.125l16.988,21.234l16.986-21.234v33.125h16.987v-57.756h-16.987l-16.986,21.234
|
||||
l-16.988-21.234H625.25v57.756H642.236z"/>
|
||||
<path fill="#010101" d="M756.05,150.272h-16.987v-28.878h-16.986v28.878H705.09L730.569,180L756.05,150.272z"/>
|
||||
</g>
|
||||
<path fill="#010101" d="M776,90H606c-11.028,0-20,8.972-20,20v170c0,11.028,8.972,20,20,20h170c11.028,0,20-8.972,20-20V110
|
||||
C796,98.972,787.028,90,776,90z M606,100h170c5.514,0,10,4.486,10,10v83H596v-83C596,104.486,600.486,100,606,100z M776,290H606
|
||||
c-5.514,0-10-4.486-10-10v-82h190v82C786,285.514,781.514,290,776,290z"/>
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 11 KiB |
|
|
@ -0,0 +1,32 @@
|
|||
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" id="Layer_1" x="0px" y="0px" width="300px" height="439.589px" viewBox="100 100 400 400" xml:space="preserve">
|
||||
<g>
|
||||
<g id="Marked_Letters">
|
||||
<path fill="#010101" d="M185.044,358.869h-9.961l-1.143-25.986l-14.092,25.986h-6.24l-6.709-26.807l-8.818,26.807h-10.225 l13.389-40.605h10.928l6.416,25.781l13.916-25.781h10.635L185.044,358.869z"/>
|
||||
<path fill="#010101" d="M226.617,358.869h-10.811l-1.084-8.994H202.33l-4.102,8.994h-10.605l20.566-40.605h10.986L226.617,358.869 z M214.019,344.162l-1.934-15.527l-7.061,15.527H214.019z"/>
|
||||
<path fill="#010101" d="M267.712,358.869h-11.338l-4.043-8.467c-1.191-2.559-2.227-4.478-3.105-5.757s-1.651-2.07-2.314-2.373 c-0.664-0.303-1.553-0.454-2.666-0.454h-1.553l-2.578,17.051h-10.283l5.889-40.605h15.85c5.761,0,9.672,1.27,11.733,3.809 c2.061,2.539,3.091,5.283,3.091,8.232c0,3.105-0.854,5.522-2.563,7.251c-1.709,1.729-4.097,2.798-7.163,3.208 c1.562,0.898,2.769,1.953,3.618,3.164s1.86,3.096,3.032,5.654L267.712,358.869z M255.525,330.012c0-1.562-0.571-2.925-1.714-4.087 s-3.453-1.743-6.929-1.743h-1.611l-1.699,11.719h4.102c2.89,0,4.922-0.61,6.094-1.831S255.525,331.496,255.525,330.012z"/>
|
||||
<path fill="#010101" d="M313.705,318.264l-17.578,18.223l14.912,22.383h-11.807l-14.59-21.65l-3.282,21.65h-10.342l6.064-40.605 h10.401l-2.578,17.256l16.611-17.256H313.705z"/>
|
||||
<path fill="#010101" d="M346.426,318.264L345.4,325.5h-16.436l-1.26,8.818h14.268l-1.025,7.266h-14.385l-1.377,10.02h19.98 l-1.025,7.266h-30.439l5.889-40.605H346.426z"/>
|
||||
<path fill="#010101" d="M389.953,338.156c0,4.512-0.86,8.301-2.578,11.367c-1.719,3.066-4.273,5.391-7.662,6.973 s-7.583,2.373-12.582,2.373H348.41l5.83-40.605h14.941c3.534,0,6.625,0.527,9.271,1.582s4.82,2.51,6.52,4.365 s2.953,3.97,3.764,6.343S389.953,335.461,389.953,338.156z M379.377,338.303c0-2.031-0.387-4.004-1.158-5.918 s-2.192-3.54-4.262-4.878c-2.07-1.338-4.941-2.007-8.613-2.007h-1.67l-3.779,26.104h5.449c2.597,0,4.828-0.391,6.693-1.172 s3.33-1.821,4.395-3.12s1.821-2.71,2.271-4.233C379.152,341.555,379.377,339.963,379.377,338.303z"/>
|
||||
</g>
|
||||
<g>
|
||||
<path fill="#010101" d="M406.922,307.149l-3.703,26.35c-0.609,4.324-2.72,6.486-6.33,6.486c-0.773,0-1.553-0.07-2.338-0.211 l-0.756-3.023c0.879,0.188,1.67,0.281,2.373,0.281c1.219,0,2.118-0.302,2.698-0.905s0.964-1.55,1.151-2.839l3.674-26.139H406.922z "/>
|
||||
<path fill="#010101" d="M423.027,307.8l-0.475,3.357c-1.312-0.867-2.748-1.301-4.307-1.301c-1.312,0-2.361,0.34-3.146,1.02 s-1.178,1.576-1.178,2.689c0,0.551,0.188,1.131,0.562,1.74s1.471,1.644,3.287,3.103s3.015,2.739,3.595,3.841 s0.87,2.203,0.87,3.305c0,1.758-0.662,3.275-1.986,4.553s-3.088,1.916-5.291,1.916c-1.957,0-3.938-0.586-5.941-1.758l0.51-3.604 c2.238,1.559,4.16,2.338,5.766,2.338c0.867,0,1.69-0.284,2.47-0.852c0.779-0.568,1.169-1.339,1.169-2.312 c0-0.62-0.197-1.265-0.59-1.933c-0.394-0.667-1.502-1.745-3.324-3.232c-1.824-1.486-3.014-2.778-3.568-3.874 c-0.555-1.097-0.832-2.185-0.832-3.263c0-1.899,0.785-3.491,2.355-4.775c1.57-1.283,3.422-1.926,5.555-1.926 C420.016,306.833,421.516,307.155,423.027,307.8z"/>
|
||||
</g>
|
||||
<g>
|
||||
<g>
|
||||
<path fill="#010101" d="M357,200v-92c0-8.284-6.716-15-15-15H172c-8.284,0-15,6.716-15,15v92H357z"/>
|
||||
<path fill="#010101" d="M157,205v73c0,8.284,6.716,15,15,15h170c8.284,0,15-6.716,15-15v-73H157z"/>
|
||||
</g>
|
||||
<g>
|
||||
<path fill="#FFFFFF" d="M208.737,180.15v-33.125l16.987,21.234l16.987-21.234v33.125h16.987v-57.756h-16.987l-16.987,21.234 l-16.987-21.234H191.75v57.756H208.737z"/>
|
||||
<path fill="#FFFFFF" d="M322.55,151.272h-16.987v-28.878h-16.986v28.878h-16.987L297.069,181L322.55,151.272z"/>
|
||||
</g>
|
||||
<g>
|
||||
<path fill="#FFFFFF" d="M217,241.154c0,2.124-1.722,3.846-3.845,3.846h-5.31c-2.124,0-3.845-1.722-3.845-3.846v-0.309 c0-2.124,1.722-3.846,3.845-3.846h5.31c2.124,0,3.845,1.722,3.845,3.846V241.154z"/>
|
||||
<path fill="#FFFFFF" d="M207.859,256.5c0,1.933-1.1,3.5-2.457,3.5h-12.046c-1.357,0-2.457-1.567-2.457-3.5l0,0 c0-1.933,1.1-3.5,2.457-3.5h12.046C206.759,253,207.859,254.567,207.859,256.5L207.859,256.5z"/>
|
||||
<path fill="#FFFFFF" d="M328.044,238.021c-1.058-3.094-2.692-5.85-4.907-8.269c-2.215-2.418-5.049-4.314-8.498-5.689 c-3.45-1.375-7.479-2.063-12.086-2.063h-19.477l-7.6,52.932h24.403c6.518,0,11.984-1.032,16.402-3.094 c4.416-2.062,7.746-5.092,9.986-9.09c2.24-3.996,3.361-8.936,3.361-14.817C329.629,244.418,329.1,241.115,328.044,238.021z M314.964,254.347c-0.586,1.986-1.573,3.826-2.96,5.519c-1.389,1.694-3.297,3.049-5.729,4.067s-5.34,1.528-8.727,1.528h-7.103 l4.927-34.027h2.176c4.787,0,8.529,0.872,11.229,2.616c2.698,1.744,4.55,3.863,5.557,6.358c1.005,2.494,1.508,5.066,1.508,7.713 C315.842,250.286,315.549,252.361,314.964,254.347z"/>
|
||||
<path fill="#FFFFFF" d="M246.148,241.043l1.373-9.61h21.424l1.336-9.434h-10.601h-24.38h-1.256c-2.125,0-3.846,1.877-3.846,4 s1.721,4,3.846,4h0.096h3.793c1.928,0,3.491,1.563,3.491,3.491c0,1.928-1.563,3.491-3.491,3.491h-4.806L233.126,237h-8.983 c-1.299,0-2.353,1.786-2.353,3.988c0,2.203,1.053,3.989,2.353,3.989h7.826L231.966,245h3.189c2.124,0,3.845,1.722,3.845,3.846 v0.309c0,2.124-1.722,3.846-3.845,3.846h-4.349h-0.96H216.2c-1.933,0-3.5,1.567-3.5,3.5s1.567,3.5,3.5,3.5h8.645h4.945h0.364 c2.124,0,3.845,1.722,3.845,3.846v0.309c0,2.124-1.722,3.846-3.845,3.846h-1.524h-3.785h-1.8c-2.125,0-3.846,1.377-3.846,3.5 s1.721,3.5,3.846,3.5h25.636c0.273,0,0.538-0.024,0.795-0.068h17.828l1.336-9.471h-26.045l1.795-13.062h18.751l1.336-9.471 h-18.598l0.029-0.205C246.055,242.213,246.144,241.647,246.148,241.043z"/>
|
||||
</g>
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 5.5 KiB |
|
|
@ -0,0 +1,270 @@
|
|||
<!doctype html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8"/>
|
||||
<title>Marked.js Documentation</title>
|
||||
<style>
|
||||
body {
|
||||
font-family: -apple-system,BlinkMacSystemFont,"Segoe UI",Helvetica,Arial,sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol";
|
||||
font-size: 16px;
|
||||
line-height: 1.5;
|
||||
word-wrap: break-word;
|
||||
background: #F9F9F9;
|
||||
}
|
||||
|
||||
#container {
|
||||
max-width: 900px;
|
||||
margin: auto;
|
||||
}
|
||||
|
||||
#content {
|
||||
padding: 5px 10px;
|
||||
border: 1px solid #ddd;
|
||||
border-radius: 3px;
|
||||
background: white;
|
||||
}
|
||||
|
||||
#content h1:first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
nav {
|
||||
border: 1px solid #ddd;
|
||||
border-radius: 3px;
|
||||
background: white;
|
||||
margin-right: 10px;
|
||||
}
|
||||
|
||||
nav > ul {
|
||||
position: sticky;
|
||||
top: 5px;
|
||||
margin: 10px 0px;
|
||||
padding: 0;
|
||||
list-style-type: none;
|
||||
font-size: 14px;
|
||||
}
|
||||
|
||||
nav > ul > li {
|
||||
min-width: 125px;
|
||||
padding: 0px 15px;
|
||||
}
|
||||
|
||||
nav > ul > li > ul {
|
||||
padding-left: 25px;
|
||||
}
|
||||
|
||||
nav > ul > li > ul > li {
|
||||
font-size: 0.8em;
|
||||
}
|
||||
|
||||
nav .selected {
|
||||
color: #111;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
nav .selected:hover {
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
header {
|
||||
display: flex;
|
||||
height: 50px;
|
||||
}
|
||||
|
||||
header h1 { margin: 0; }
|
||||
|
||||
table {
|
||||
border-spacing: 0;
|
||||
border-collapse: collapse;
|
||||
border: 1px solid #ddd;
|
||||
}
|
||||
|
||||
td, th {
|
||||
border: 1px solid #ddd;
|
||||
padding: 5px;
|
||||
}
|
||||
|
||||
a {
|
||||
color: #0366d6;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
pre {
|
||||
font-family: "SFMono-Regular",Consolas,"Liberation Mono",Menlo,Courier,monospace;
|
||||
padding: 16px;
|
||||
overflow: auto;
|
||||
font-size: 85%;
|
||||
line-height: 1.45;
|
||||
background-color: #f6f8fa;
|
||||
border-radius: 3px;
|
||||
}
|
||||
|
||||
code:not([class]) {
|
||||
padding: 0.2em 0.4em;
|
||||
margin: 0;
|
||||
font-size: 85%;
|
||||
background-color: rgba(27,31,35,0.05);
|
||||
border-radius: 3px;
|
||||
}
|
||||
|
||||
.github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}}
|
||||
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<a href="https://github.com/markedjs/marked" class="github-corner" aria-label="View source on Github">
|
||||
<svg width="80" height="80" viewBox="0 0 250 250" style="fill:#202020; color:#fff; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true">
|
||||
<path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>
|
||||
<path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path>
|
||||
<path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path>
|
||||
</svg>
|
||||
</a>
|
||||
<div id="container">
|
||||
<header>
|
||||
<a href="#/README.md">
|
||||
<img src="img/logo-black.svg" height="64px" width="64px" />
|
||||
</a>
|
||||
<h1>Marked.js Documentation</h1>
|
||||
</header>
|
||||
<div style="display: flex">
|
||||
<nav>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="#/README.md">Getting Started</a>
|
||||
<ul>
|
||||
<li><a href="#/README.md#demo">Demo</a></li>
|
||||
<li><a href="#/README.md#installation">Installation</a></li>
|
||||
<li><a href="#/README.md#usage">Usage</a></li>
|
||||
<li><a href="#/README.md#specifications">Specs</a></li>
|
||||
<li><a href="#/README.md#security">Security</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#/USING_ADVANCED.md">Advanced Usage</a>
|
||||
<ul>
|
||||
<li><a href="#/USING_ADVANCED.md#options">Options</a></li>
|
||||
<li><a href="#/USING_ADVANCED.md#highlight">Highlighting</a></li>
|
||||
<li><a href="#/USING_ADVANCED.md#workers">Workers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#/USING_PRO.md">Extensibility</a>
|
||||
<ul>
|
||||
<li><a href="#/USING_PRO.md#renderer">Renderer</a></li>
|
||||
<li><a href="#/USING_PRO.md#lexer">Lexer</a></li>
|
||||
<li><a href="#/USING_PRO.md#parser">Parser</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#/CONTRIBUTING.md">Contributing</a>
|
||||
<ul>
|
||||
<li><a href="#/CONTRIBUTING.md#design-principles">Design Principles</a></li>
|
||||
<li><a href="#/CONTRIBUTING.md#priorities">Priorities</a></li>
|
||||
<li><a href="#/CONTRIBUTING.md#test-early-often-and-everything">Testing</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#/CODE_OF_CONDUCT.md">Code of Conduct</a></li>
|
||||
<li><a href="#/AUTHORS.md">Authors</a></li>
|
||||
<li><a href="#/PUBLISHING.md">Publishing</a></li>
|
||||
<li><a href="https://github.com/markedjs/marked/blob/master/LICENSE.md">License</a></li>
|
||||
</ul>
|
||||
</nav>
|
||||
<div id="content"></div>
|
||||
</div>
|
||||
</div>
|
||||
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/es6-promise/dist/es6-promise.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/unfetch/dist/unfetch.umd.js"></script>
|
||||
<script>
|
||||
if (!window.Promise) {
|
||||
window.Promise = ES6Promise;
|
||||
}
|
||||
if (!window.fetch) {
|
||||
window.fetch = unfetch;
|
||||
}
|
||||
|
||||
var content = document.querySelector('#content');
|
||||
var body = document.querySelector('html');
|
||||
var navLinks = document.querySelectorAll('nav a');
|
||||
var currentPage = 'README.md';
|
||||
var currentHash = '';
|
||||
var renderedPage = '';
|
||||
|
||||
function hashChange() {
|
||||
var hash = location.hash.slice(1);
|
||||
if (!hash) {
|
||||
hash = 'README.md';
|
||||
}
|
||||
|
||||
var uri = hash.split('#');
|
||||
|
||||
if (uri[0].match(/^\//)) {
|
||||
currentPage = uri[0].slice(1);
|
||||
if (uri.length > 1) {
|
||||
currentHash = uri[1];
|
||||
} else {
|
||||
currentHash = '';
|
||||
}
|
||||
} else {
|
||||
currentHash = uri[0];
|
||||
}
|
||||
|
||||
fetchPage(currentPage).then(function () {
|
||||
fetchAnchor(currentHash)
|
||||
});
|
||||
|
||||
var url = '#/' + currentPage + (currentHash ? '#' + currentHash : '');
|
||||
var fullUrl = window.location.origin + '/' + url;
|
||||
|
||||
navLinks.forEach(function(link) {
|
||||
link.className = link.href === fullUrl ? 'selected' : '';
|
||||
});
|
||||
|
||||
history.replaceState('', document.title, url);
|
||||
}
|
||||
|
||||
function fetchAnchor(anchor) {
|
||||
if (!anchor) {
|
||||
return;
|
||||
}
|
||||
|
||||
var hashElement = document.getElementById(anchor);
|
||||
if (hashElement) {
|
||||
hashElement.scrollIntoView();
|
||||
}
|
||||
}
|
||||
|
||||
function fetchPage(page) {
|
||||
if (page === renderedPage) {
|
||||
return Promise.resolve();
|
||||
}
|
||||
return fetch(page)
|
||||
.then(function (res) {
|
||||
if (!res.ok) {
|
||||
throw new Error('Error ' + res.status + ': ' + res.statusText);
|
||||
}
|
||||
return res.text();
|
||||
})
|
||||
.then(function (text) {
|
||||
renderedPage = page;
|
||||
content.innerHTML = marked(text);
|
||||
body.scrollTop = 0;
|
||||
}).catch(function (e) {
|
||||
content.innerHTML = '<p>Oops! There was a problem rendering the page.</p>'
|
||||
+ '<p>' + e.message + '</p>';
|
||||
});
|
||||
}
|
||||
|
||||
window.addEventListener('hashchange', function (e) {
|
||||
e.preventDefault();
|
||||
hashChange();
|
||||
});
|
||||
|
||||
hashChange();
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1 @@
|
|||
module.exports = require('./lib/marked');
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
{
|
||||
"spec_dir": "test",
|
||||
"spec_files": [
|
||||
"**/*-spec.js"
|
||||
],
|
||||
"helpers": [
|
||||
"helpers/helpers.js"
|
||||
],
|
||||
"stopSpecOnExpectationFailure": false,
|
||||
"random": true
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,111 @@
|
|||
.ds q \N'34'
|
||||
.TH marked 1
|
||||
|
||||
.SH NAME
|
||||
marked \- a javascript markdown parser
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B marked
|
||||
[\-o \fI<output>\fP] [\-i \fI<input>\fP] [\-\-help]
|
||||
[\-\-tokens] [\-\-pedantic] [\-\-gfm]
|
||||
[\-\-breaks] [\-\-sanitize]
|
||||
[\-\-smart\-lists] [\-\-lang\-prefix \fI<prefix>\fP]
|
||||
[\-\-no\-etc...] [\-\-silent] [\fIfilename\fP]
|
||||
|
||||
.SH DESCRIPTION
|
||||
.B marked
|
||||
is a full-featured javascript markdown parser, built for speed.
|
||||
It also includes multiple GFM features.
|
||||
|
||||
.SH EXAMPLES
|
||||
.TP
|
||||
cat in.md | marked > out.html
|
||||
.TP
|
||||
echo "hello *world*" | marked
|
||||
.TP
|
||||
marked \-o out.html \-i in.md \-\-gfm
|
||||
.TP
|
||||
marked \-\-output="hello world.html" \-i in.md \-\-no-breaks
|
||||
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BI \-o,\ \-\-output\ [\fIoutput\fP]
|
||||
Specify file output. If none is specified, write to stdout.
|
||||
.TP
|
||||
.BI \-i,\ \-\-input\ [\fIinput\fP]
|
||||
Specify file input, otherwise use last argument as input file.
|
||||
If no input file is specified, read from stdin.
|
||||
.TP
|
||||
.BI \-\-test
|
||||
Makes sure the test(s) pass.
|
||||
.RS
|
||||
.PP
|
||||
.B \-\-glob [\fIfile\fP]
|
||||
Specify which test to use.
|
||||
.PP
|
||||
.B \-\-fix
|
||||
Fixes tests.
|
||||
.PP
|
||||
.B \-\-bench
|
||||
Benchmarks the test(s).
|
||||
.PP
|
||||
.B \-\-time
|
||||
Times The test(s).
|
||||
.PP
|
||||
.B \-\-minified
|
||||
Runs test file(s) as minified.
|
||||
.PP
|
||||
.B \-\-stop
|
||||
Stop process if a test fails.
|
||||
.RE
|
||||
.TP
|
||||
.BI \-t,\ \-\-tokens
|
||||
Output a token stream instead of html.
|
||||
.TP
|
||||
.BI \-\-pedantic
|
||||
Conform to obscure parts of markdown.pl as much as possible.
|
||||
Don't fix original markdown bugs.
|
||||
.TP
|
||||
.BI \-\-gfm
|
||||
Enable github flavored markdown.
|
||||
.TP
|
||||
.BI \-\-breaks
|
||||
Enable GFM line breaks. Only works with the gfm option.
|
||||
.TP
|
||||
.BI \-\-sanitize
|
||||
Sanitize output. Ignore any HTML input.
|
||||
.TP
|
||||
.BI \-\-smart\-lists
|
||||
Use smarter list behavior than the original markdown.
|
||||
.TP
|
||||
.BI \-\-lang\-prefix\ [\fIprefix\fP]
|
||||
Set the prefix for code block classes.
|
||||
.TP
|
||||
.BI \-\-mangle
|
||||
Mangle email addresses.
|
||||
.TP
|
||||
.BI \-\-no\-sanitize,\ \-no-etc...
|
||||
The inverse of any of the marked options above.
|
||||
.TP
|
||||
.BI \-\-silent
|
||||
Silence error output.
|
||||
.TP
|
||||
.BI \-h,\ \-\-help
|
||||
Display help information.
|
||||
|
||||
.SH CONFIGURATION
|
||||
For configuring and running programmatically.
|
||||
|
||||
.B Example
|
||||
|
||||
require('marked')('*foo*', { gfm: true });
|
||||
|
||||
.SH BUGS
|
||||
Please report any bugs to https://github.com/markedjs/marked.
|
||||
|
||||
.SH LICENSE
|
||||
Copyright (c) 2011-2014, Christopher Jeffrey (MIT License).
|
||||
|
||||
.SH "SEE ALSO"
|
||||
.BR markdown(1),
|
||||
.BR node.js(1)
|
||||
|
|
@ -0,0 +1,96 @@
|
|||
marked(1) General Commands Manual marked(1)
|
||||
|
||||
NAME
|
||||
marked - a javascript markdown parser
|
||||
|
||||
SYNOPSIS
|
||||
marked [-o <output>] [-i <input>] [--help] [--tokens] [--pedantic]
|
||||
[--gfm] [--breaks] [--sanitize] [--smart-lists] [--lang-prefix <pre-
|
||||
fix>] [--no-etc...] [--silent] [filename]
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
marked is a full-featured javascript markdown parser, built for speed.
|
||||
It also includes multiple GFM features.
|
||||
|
||||
EXAMPLES
|
||||
cat in.md | marked > out.html
|
||||
|
||||
echo "hello *world*" | marked
|
||||
|
||||
marked -o out.html -i in.md --gfm
|
||||
|
||||
marked --output="hello world.html" -i in.md --no-breaks
|
||||
|
||||
OPTIONS
|
||||
-o, --output [output]
|
||||
Specify file output. If none is specified, write to stdout.
|
||||
|
||||
-i, --input [input]
|
||||
Specify file input, otherwise use last argument as input file.
|
||||
If no input file is specified, read from stdin.
|
||||
|
||||
--test Makes sure the test(s) pass.
|
||||
|
||||
--glob [file] Specify which test to use.
|
||||
|
||||
--fix Fixes tests.
|
||||
|
||||
--bench Benchmarks the test(s).
|
||||
|
||||
--time Times The test(s).
|
||||
|
||||
--minified Runs test file(s) as minified.
|
||||
|
||||
--stop Stop process if a test fails.
|
||||
|
||||
-t, --tokens
|
||||
Output a token stream instead of html.
|
||||
|
||||
--pedantic
|
||||
Conform to obscure parts of markdown.pl as much as possible.
|
||||
Don't fix original markdown bugs.
|
||||
|
||||
--gfm Enable github flavored markdown.
|
||||
|
||||
--breaks
|
||||
Enable GFM line breaks. Only works with the gfm option.
|
||||
|
||||
--sanitize
|
||||
Sanitize output. Ignore any HTML input.
|
||||
|
||||
--smart-lists
|
||||
Use smarter list behavior than the original markdown.
|
||||
|
||||
--lang-prefix [prefix]
|
||||
Set the prefix for code block classes.
|
||||
|
||||
--mangle
|
||||
Mangle email addresses.
|
||||
|
||||
--no-sanitize, -no-etc...
|
||||
The inverse of any of the marked options above.
|
||||
|
||||
--silent
|
||||
Silence error output.
|
||||
|
||||
-h, --help
|
||||
Display help information.
|
||||
|
||||
CONFIGURATION
|
||||
For configuring and running programmatically.
|
||||
|
||||
Example
|
||||
|
||||
require('marked')('*foo*', { gfm: true });
|
||||
|
||||
BUGS
|
||||
Please report any bugs to https://github.com/markedjs/marked.
|
||||
|
||||
LICENSE
|
||||
Copyright (c) 2011-2014, Christopher Jeffrey (MIT License).
|
||||
|
||||
SEE ALSO
|
||||
markdown(1), node.js(1)
|
||||
|
||||
marked(1)
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,65 @@
|
|||
{
|
||||
"name": "marked",
|
||||
"description": "A markdown parser built for speed",
|
||||
"author": "Christopher Jeffrey",
|
||||
"version": "0.7.0",
|
||||
"main": "./lib/marked.js",
|
||||
"bin": "./bin/marked",
|
||||
"man": "./man/marked.1",
|
||||
"files": [
|
||||
"bin/",
|
||||
"lib/",
|
||||
"man/",
|
||||
"marked.min.js"
|
||||
],
|
||||
"repository": "git://github.com/markedjs/marked.git",
|
||||
"homepage": "https://marked.js.org",
|
||||
"bugs": {
|
||||
"url": "http://github.com/markedjs/marked/issues"
|
||||
},
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"markdown",
|
||||
"markup",
|
||||
"html"
|
||||
],
|
||||
"tags": [
|
||||
"markdown",
|
||||
"markup",
|
||||
"html"
|
||||
],
|
||||
"devDependencies": {
|
||||
"@markedjs/html-differ": "^2.0.1",
|
||||
"cheerio": "^1.0.0-rc.3",
|
||||
"commonmark": "0.x",
|
||||
"eslint": "^5.16.0",
|
||||
"eslint-config-standard": "^12.0.0",
|
||||
"eslint-plugin-import": "^2.17.2",
|
||||
"eslint-plugin-node": "^8.0.1",
|
||||
"eslint-plugin-promise": "^4.1.1",
|
||||
"eslint-plugin-standard": "^4.0.0",
|
||||
"eslint-plugin-vuln-regex-detector": "^1.0.4",
|
||||
"front-matter": "^3.0.2",
|
||||
"jasmine": "^3.4.0",
|
||||
"markdown": "0.x",
|
||||
"markdown-it": "8.x",
|
||||
"node-fetch": "^2.3.0",
|
||||
"uglify-js": "^3.5.8"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "jasmine --config=jasmine.json",
|
||||
"test:unit": "npm test -- test/unit/**/*-spec.js",
|
||||
"test:specs": "npm test -- test/specs/**/*-spec.js",
|
||||
"test:lint": "eslint bin/marked .",
|
||||
"test:redos": "eslint --plugin vuln-regex-detector --rule '\"vuln-regex-detector/no-vuln-regex\": 2' lib/marked.js",
|
||||
"test:node4": "npx node@4 ./node_modules/jasmine/bin/jasmine.js --config=jasmine.json",
|
||||
"test:update": "node test/update-specs.js",
|
||||
"bench": "node test/bench.js",
|
||||
"lint": "eslint --fix bin/marked .",
|
||||
"build": "uglifyjs lib/marked.js -cm --comments /Copyright/ -o marked.min.js",
|
||||
"preversion": "npm run build && (git diff --quiet || git commit -am 'minify')"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=0.10.0"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
{
|
||||
"extends": "standard",
|
||||
"plugins": [
|
||||
"standard"
|
||||
],
|
||||
"rules": {
|
||||
"semi": ["error", "always"],
|
||||
"indent": ["error", 2, {
|
||||
"SwitchCase": 1,
|
||||
"VariableDeclarator": { "var": 2 },
|
||||
"outerIIFEBody": 0
|
||||
}],
|
||||
"operator-linebreak": ["error", "before", { "overrides": { "=": "after" } }],
|
||||
"space-before-function-paren": ["error", "never"],
|
||||
"no-cond-assign": "off",
|
||||
"no-useless-escape": "off",
|
||||
"one-var": "off",
|
||||
"no-control-regex": "off",
|
||||
|
||||
"prefer-const": "error",
|
||||
"no-var": "error"
|
||||
},
|
||||
"env": {
|
||||
"node": true,
|
||||
"jasmine": true
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,263 @@
|
|||
const path = require('path');
|
||||
const htmlDiffer = require('./helpers/html-differ.js');
|
||||
const { loadFiles } = require('./helpers/load.js');
|
||||
|
||||
let marked = require('../');
|
||||
|
||||
/**
|
||||
* Load specs
|
||||
*/
|
||||
function load() {
|
||||
const dir = path.resolve(__dirname, './specs/commonmark');
|
||||
const sections = loadFiles(dir);
|
||||
let specs = [];
|
||||
|
||||
for (const section in sections) {
|
||||
specs = specs.concat(sections[section].specs);
|
||||
}
|
||||
|
||||
return specs;
|
||||
}
|
||||
|
||||
/**
|
||||
* Run all benchmarks
|
||||
*/
|
||||
function runBench(options) {
|
||||
options = options || {};
|
||||
const specs = load();
|
||||
|
||||
// Non-GFM, Non-pedantic
|
||||
marked.setOptions({
|
||||
gfm: false,
|
||||
breaks: false,
|
||||
pedantic: false,
|
||||
sanitize: false,
|
||||
smartLists: false
|
||||
});
|
||||
if (options.marked) {
|
||||
marked.setOptions(options.marked);
|
||||
}
|
||||
bench('marked', specs, marked);
|
||||
|
||||
// GFM
|
||||
marked.setOptions({
|
||||
gfm: true,
|
||||
breaks: false,
|
||||
pedantic: false,
|
||||
sanitize: false,
|
||||
smartLists: false
|
||||
});
|
||||
if (options.marked) {
|
||||
marked.setOptions(options.marked);
|
||||
}
|
||||
bench('marked (gfm)', specs, marked);
|
||||
|
||||
// Pedantic
|
||||
marked.setOptions({
|
||||
gfm: false,
|
||||
breaks: false,
|
||||
pedantic: true,
|
||||
sanitize: false,
|
||||
smartLists: false
|
||||
});
|
||||
if (options.marked) {
|
||||
marked.setOptions(options.marked);
|
||||
}
|
||||
bench('marked (pedantic)', specs, marked);
|
||||
|
||||
try {
|
||||
bench('commonmark', specs, (() => {
|
||||
const commonmark = require('commonmark');
|
||||
const parser = new commonmark.Parser();
|
||||
const writer = new commonmark.HtmlRenderer();
|
||||
return function(text) {
|
||||
return writer.render(parser.parse(text));
|
||||
};
|
||||
})());
|
||||
} catch (e) {
|
||||
console.error('Could not bench commonmark. (Error: %s)', e.message);
|
||||
}
|
||||
|
||||
try {
|
||||
bench('markdown-it', specs, (() => {
|
||||
const MarkdownIt = require('markdown-it');
|
||||
const md = new MarkdownIt();
|
||||
return md.render.bind(md);
|
||||
})());
|
||||
} catch (e) {
|
||||
console.error('Could not bench markdown-it. (Error: %s)', e.message);
|
||||
}
|
||||
|
||||
try {
|
||||
bench('markdown.js', specs, (() => {
|
||||
const md = require('markdown').markdown;
|
||||
return md.toHTML.bind(md);
|
||||
})());
|
||||
} catch (e) {
|
||||
console.error('Could not bench markdown.js. (Error: %s)', e.message);
|
||||
}
|
||||
}
|
||||
|
||||
function bench(name, specs, engine) {
|
||||
const before = process.hrtime();
|
||||
for (let i = 0; i < 1e3; i++) {
|
||||
for (const spec of specs) {
|
||||
engine(spec.markdown);
|
||||
}
|
||||
}
|
||||
const elapsed = process.hrtime(before);
|
||||
const ms = prettyElapsedTime(elapsed).toFixed();
|
||||
|
||||
const results = [];
|
||||
for (const spec of specs) {
|
||||
results.push({
|
||||
expected: spec.html,
|
||||
actual: engine(spec.markdown)
|
||||
});
|
||||
}
|
||||
const correct = results.reduce((num, result) => num + (htmlDiffer.isEqual(result.expected, result.actual) ? 1 : 0), 0);
|
||||
const percent = (correct / results.length * 100).toFixed(2);
|
||||
|
||||
console.log('%s completed in %sms and passed %s%', name, ms, percent);
|
||||
}
|
||||
|
||||
/**
|
||||
* A simple one-time benchmark
|
||||
*/
|
||||
function time(options) {
|
||||
options = options || {};
|
||||
const specs = load();
|
||||
if (options.marked) {
|
||||
marked.setOptions(options.marked);
|
||||
}
|
||||
bench('marked', specs, marked);
|
||||
}
|
||||
|
||||
/**
|
||||
* Argument Parsing
|
||||
*/
|
||||
function parseArg(argv) {
|
||||
argv = argv.slice(2);
|
||||
|
||||
const options = {};
|
||||
const orphans = [];
|
||||
|
||||
function getarg() {
|
||||
let arg = argv.shift();
|
||||
|
||||
if (arg.indexOf('--') === 0) {
|
||||
// e.g. --opt
|
||||
arg = arg.split('=');
|
||||
if (arg.length > 1) {
|
||||
// e.g. --opt=val
|
||||
argv.unshift(arg.slice(1).join('='));
|
||||
}
|
||||
arg = arg[0];
|
||||
} else if (arg[0] === '-') {
|
||||
if (arg.length > 2) {
|
||||
// e.g. -abc
|
||||
argv = arg.substring(1).split('').map(ch => {
|
||||
return `-${ch}`;
|
||||
}).concat(argv);
|
||||
arg = argv.shift();
|
||||
} else {
|
||||
// e.g. -a
|
||||
}
|
||||
} else {
|
||||
// e.g. foo
|
||||
}
|
||||
|
||||
return arg;
|
||||
}
|
||||
|
||||
const defaults = marked.getDefaults();
|
||||
|
||||
while (argv.length) {
|
||||
const arg = getarg();
|
||||
switch (arg) {
|
||||
case '-t':
|
||||
case '--time':
|
||||
options.time = true;
|
||||
break;
|
||||
case '-m':
|
||||
case '--minified':
|
||||
options.minified = true;
|
||||
break;
|
||||
default:
|
||||
if (arg.indexOf('--') === 0) {
|
||||
const opt = camelize(arg.replace(/^--(no-)?/, ''));
|
||||
if (!defaults.hasOwnProperty(opt)) {
|
||||
continue;
|
||||
}
|
||||
options.marked = options.marked || {};
|
||||
if (arg.indexOf('--no-') === 0) {
|
||||
options.marked[opt] = typeof defaults[opt] !== 'boolean'
|
||||
? null
|
||||
: false;
|
||||
} else {
|
||||
options.marked[opt] = typeof defaults[opt] !== 'boolean'
|
||||
? argv.shift()
|
||||
: true;
|
||||
}
|
||||
} else {
|
||||
orphans.push(arg);
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (orphans.length > 0) {
|
||||
console.error();
|
||||
console.error('The following arguments are not used:');
|
||||
orphans.forEach(arg => console.error(` ${arg}`));
|
||||
console.error();
|
||||
}
|
||||
|
||||
return options;
|
||||
}
|
||||
|
||||
/**
|
||||
* Helpers
|
||||
*/
|
||||
function camelize(text) {
|
||||
return text.replace(/(\w)-(\w)/g, (_, a, b) => a + b.toUpperCase());
|
||||
}
|
||||
|
||||
/**
|
||||
* Main
|
||||
*/
|
||||
function main(argv) {
|
||||
const opt = parseArg(argv);
|
||||
|
||||
if (opt.minified) {
|
||||
marked = require('../marked.min.js');
|
||||
}
|
||||
|
||||
if (opt.time) {
|
||||
time(opt);
|
||||
} else {
|
||||
runBench(opt);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* returns time to millisecond granularity
|
||||
*/
|
||||
function prettyElapsedTime(hrtimeElapsed) {
|
||||
const seconds = hrtimeElapsed[0];
|
||||
const frac = Math.round(hrtimeElapsed[1] / 1e3) / 1e3;
|
||||
return seconds * 1e3 + frac;
|
||||
}
|
||||
|
||||
if (!module.parent) {
|
||||
process.title = 'marked bench';
|
||||
main(process.argv.slice());
|
||||
} else {
|
||||
exports = main;
|
||||
exports.main = main;
|
||||
exports.time = time;
|
||||
exports.runBench = runBench;
|
||||
exports.load = load;
|
||||
exports.bench = bench;
|
||||
module.exports = exports;
|
||||
}
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
const marked = require('../../');
|
||||
const htmlDiffer = require('./html-differ.js');
|
||||
|
||||
beforeEach(() => {
|
||||
marked.setOptions(marked.getDefaults());
|
||||
|
||||
jasmine.addMatchers({
|
||||
toRender: () => {
|
||||
return {
|
||||
compare: (spec, expected) => {
|
||||
const result = {};
|
||||
const actual = marked(spec.markdown, spec.options);
|
||||
result.pass = htmlDiffer.isEqual(expected, actual);
|
||||
|
||||
if (result.pass) {
|
||||
result.message = `${spec.markdown}\n------\n\nExpected: Should Fail`;
|
||||
} else {
|
||||
const diff = htmlDiffer.firstDiff(actual, expected);
|
||||
result.message = `Expected: ${diff.expected}\n Actual: ${diff.actual}`;
|
||||
}
|
||||
return result;
|
||||
}
|
||||
};
|
||||
}
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
const HtmlDiffer = require('@markedjs/html-differ').HtmlDiffer;
|
||||
const htmlDiffer = new HtmlDiffer({ ignoreSelfClosingSlash: true });
|
||||
|
||||
module.exports = {
|
||||
isEqual: htmlDiffer.isEqual.bind(htmlDiffer),
|
||||
firstDiff: (actual, expected, padding) => {
|
||||
padding = padding || 30;
|
||||
const result = htmlDiffer
|
||||
.diffHtml(actual, expected)
|
||||
.reduce((obj, diff) => {
|
||||
if (diff.added) {
|
||||
if (obj.firstIndex === null) {
|
||||
obj.firstIndex = obj.expected.length;
|
||||
}
|
||||
obj.expected += diff.value;
|
||||
} else if (diff.removed) {
|
||||
if (obj.firstIndex === null) {
|
||||
obj.firstIndex = obj.actual.length;
|
||||
}
|
||||
obj.actual += diff.value;
|
||||
} else {
|
||||
obj.actual += diff.value;
|
||||
obj.expected += diff.value;
|
||||
}
|
||||
|
||||
return obj;
|
||||
}, {
|
||||
firstIndex: null,
|
||||
actual: '',
|
||||
expected: ''
|
||||
});
|
||||
|
||||
return {
|
||||
actual: result.actual.substring(result.firstIndex - padding, result.firstIndex + padding),
|
||||
expected: result.expected.substring(result.firstIndex - padding, result.firstIndex + padding)
|
||||
};
|
||||
}
|
||||
};
|
||||
|
|
@ -0,0 +1,132 @@
|
|||
'use strict';
|
||||
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const fm = require('front-matter');
|
||||
|
||||
function node4Polyfills() {
|
||||
// https://github.com/uxitten/polyfill/blob/master/string.polyfill.js
|
||||
// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/padEnd
|
||||
if (!String.prototype.padEnd) {
|
||||
// eslint-disable-next-line no-extend-native
|
||||
String.prototype.padEnd = function padEnd(targetLength, padString) {
|
||||
targetLength = targetLength >> 0; // floor if number or convert non-number to 0;
|
||||
padString = String((typeof padString !== 'undefined' ? padString : ' '));
|
||||
if (this.length > targetLength) {
|
||||
return String(this);
|
||||
} else {
|
||||
targetLength = targetLength - this.length;
|
||||
if (targetLength > padString.length) {
|
||||
padString += padString.repeat(targetLength / padString.length); // append to original to ensure we are longer than needed
|
||||
}
|
||||
return String(this) + padString.slice(0, targetLength);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
// https://github.com/uxitten/polyfill/blob/master/string.polyfill.js
|
||||
// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/padStart
|
||||
if (!String.prototype.padStart) {
|
||||
// eslint-disable-next-line no-extend-native
|
||||
String.prototype.padStart = function padStart(targetLength, padString) {
|
||||
targetLength = targetLength >> 0; // truncate if number, or convert non-number to 0;
|
||||
padString = String(typeof padString !== 'undefined' ? padString : ' ');
|
||||
if (this.length >= targetLength) {
|
||||
return String(this);
|
||||
} else {
|
||||
targetLength = targetLength - this.length;
|
||||
if (targetLength > padString.length) {
|
||||
padString += padString.repeat(targetLength / padString.length); // append to original to ensure we are longer than needed
|
||||
}
|
||||
return padString.slice(0, targetLength) + String(this);
|
||||
}
|
||||
};
|
||||
}
|
||||
}
|
||||
node4Polyfills();
|
||||
|
||||
function outputCompletionTable(title, specs) {
|
||||
let longestName = 0;
|
||||
let maxSpecs = 0;
|
||||
|
||||
for (const section in specs) {
|
||||
longestName = Math.max(section.length, longestName);
|
||||
maxSpecs = Math.max(specs[section].total, maxSpecs);
|
||||
}
|
||||
|
||||
const maxSpecsLen = ('' + maxSpecs).length;
|
||||
const spaces = maxSpecsLen * 2 + longestName + 11;
|
||||
|
||||
console.log('-'.padEnd(spaces + 4, '-'));
|
||||
console.log(`| ${title.padStart(Math.ceil((spaces + title.length) / 2)).padEnd(spaces)} |`);
|
||||
console.log(`| ${' '.padEnd(spaces)} |`);
|
||||
for (const section in specs) {
|
||||
console.log(`| ${section.padEnd(longestName)} ${('' + specs[section].pass).padStart(maxSpecsLen)} of ${('' + specs[section].total).padStart(maxSpecsLen)} ${(100 * specs[section].pass / specs[section].total).toFixed().padStart(4)}% |`);
|
||||
}
|
||||
console.log('-'.padEnd(spaces + 4, '-'));
|
||||
console.log();
|
||||
}
|
||||
|
||||
function loadFiles(dir) {
|
||||
const files = fs.readdirSync(dir);
|
||||
|
||||
return files.reduce((obj, file) => {
|
||||
const ext = path.extname(file);
|
||||
const name = path.basename(file, ext);
|
||||
const absFile = path.join(dir, file);
|
||||
let specs;
|
||||
|
||||
switch (ext) {
|
||||
case '.md': {
|
||||
const content = fm(fs.readFileSync(absFile, 'utf8'));
|
||||
const skip = content.attributes.skip;
|
||||
delete content.attributes.skip;
|
||||
const only = content.attributes.only;
|
||||
delete content.attributes.only;
|
||||
specs = [{
|
||||
section: name,
|
||||
markdown: content.body,
|
||||
html: fs.readFileSync(absFile.replace(/[^.]+$/, 'html'), 'utf8'),
|
||||
options: content.attributes,
|
||||
only,
|
||||
skip
|
||||
}];
|
||||
break;
|
||||
}
|
||||
case '.js':
|
||||
case '.json': {
|
||||
specs = require(absFile);
|
||||
if (!Array.isArray(specs)) {
|
||||
specs = [specs];
|
||||
}
|
||||
break;
|
||||
}
|
||||
default:
|
||||
return obj;
|
||||
}
|
||||
|
||||
for (const spec of specs) {
|
||||
if (!spec.section) {
|
||||
spec.section = name;
|
||||
}
|
||||
if (!obj[spec.section]) {
|
||||
obj[spec.section] = {
|
||||
total: 0,
|
||||
pass: 0,
|
||||
specs: []
|
||||
};
|
||||
}
|
||||
|
||||
obj[spec.section].total++;
|
||||
obj[spec.section].pass += spec.shouldFail ? 0 : 1;
|
||||
obj[spec.section].specs.push(spec);
|
||||
}
|
||||
|
||||
return obj;
|
||||
}, {});
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
outputCompletionTable,
|
||||
loadFiles
|
||||
};
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,147 @@
|
|||
[
|
||||
{
|
||||
"section": "[extension] Tables",
|
||||
"html": "<table>\n<thead>\n<tr>\n<th>foo</th>\n<th>bar</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>baz</td>\n<td>bim</td>\n</tr>\n</tbody>\n</table>",
|
||||
"markdown": "| foo | bar |\n| --- | --- |\n| baz | bim |",
|
||||
"example": 198
|
||||
},
|
||||
{
|
||||
"section": "[extension] Tables",
|
||||
"html": "<table>\n<thead>\n<tr>\n<th align=\"center\">abc</th>\n<th align=\"right\">defghi</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td align=\"center\">bar</td>\n<td align=\"right\">baz</td>\n</tr>\n</tbody>\n</table>",
|
||||
"markdown": "| abc | defghi |\n:-: | -----------:\nbar | baz",
|
||||
"example": 199
|
||||
},
|
||||
{
|
||||
"section": "[extension] Tables",
|
||||
"html": "<table>\n<thead>\n<tr>\n<th>f|oo</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>b <code>|</code> az</td>\n</tr>\n<tr>\n<td>b <strong>|</strong> im</td>\n</tr>\n</tbody>\n</table>",
|
||||
"markdown": "| f\\|oo |\n| ------ |\n| b `\\|` az |\n| b **\\|** im |",
|
||||
"example": 200
|
||||
},
|
||||
{
|
||||
"section": "[extension] Tables",
|
||||
"html": "<table>\n<thead>\n<tr>\n<th>abc</th>\n<th>def</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>bar</td>\n<td>baz</td>\n</tr>\n</tbody>\n</table>\n<blockquote>\n<p>bar</p>\n</blockquote>",
|
||||
"markdown": "| abc | def |\n| --- | --- |\n| bar | baz |\n> bar",
|
||||
"example": 201
|
||||
},
|
||||
{
|
||||
"section": "[extension] Tables",
|
||||
"html": "<table>\n<thead>\n<tr>\n<th>abc</th>\n<th>def</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>bar</td>\n<td>baz</td>\n</tr>\n<tr>\n<td>bar</td>\n<td></td>\n</tr>\n</tbody>\n</table>\n<p>bar</p>",
|
||||
"markdown": "| abc | def |\n| --- | --- |\n| bar | baz |\nbar\n\nbar",
|
||||
"example": 202
|
||||
},
|
||||
{
|
||||
"section": "[extension] Tables",
|
||||
"html": "<p>| abc | def |\n| --- |\n| bar |</p>",
|
||||
"markdown": "| abc | def |\n| --- |\n| bar |",
|
||||
"example": 203
|
||||
},
|
||||
{
|
||||
"section": "[extension] Tables",
|
||||
"html": "<table>\n<thead>\n<tr>\n<th>abc</th>\n<th>def</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>bar</td>\n<td></td>\n</tr>\n<tr>\n<td>bar</td>\n<td>baz</td>\n</tr>\n</tbody>\n</table>",
|
||||
"markdown": "| abc | def |\n| --- | --- |\n| bar |\n| bar | baz | boo |",
|
||||
"example": 204
|
||||
},
|
||||
{
|
||||
"section": "[extension] Tables",
|
||||
"html": "<table>\n<thead>\n<tr>\n<th>abc</th>\n<th>def</th>\n</tr>\n</thead>\n</table>",
|
||||
"markdown": "| abc | def |\n| --- | --- |",
|
||||
"example": 205
|
||||
},
|
||||
{
|
||||
"section": "[extension] Task list items",
|
||||
"html": "<ul>\n<li><input disabled=\"\" type=\"checkbox\"> foo</li>\n<li><input checked=\"\" disabled=\"\" type=\"checkbox\"> bar</li>\n</ul>",
|
||||
"markdown": "- [ ] foo\n- [x] bar",
|
||||
"example": 279
|
||||
},
|
||||
{
|
||||
"section": "[extension] Task list items",
|
||||
"html": "<ul>\n<li><input checked=\"\" disabled=\"\" type=\"checkbox\"> foo\n<ul>\n<li><input disabled=\"\" type=\"checkbox\"> bar</li>\n<li><input checked=\"\" disabled=\"\" type=\"checkbox\"> baz</li>\n</ul>\n</li>\n<li><input disabled=\"\" type=\"checkbox\"> bim</li>\n</ul>",
|
||||
"markdown": "- [x] foo\n - [ ] bar\n - [x] baz\n- [ ] bim",
|
||||
"example": 280
|
||||
},
|
||||
{
|
||||
"section": "[extension] Strikethrough",
|
||||
"html": "<p><del>Hi</del> Hello, world!</p>",
|
||||
"markdown": "~~Hi~~ Hello, world!",
|
||||
"example": 491
|
||||
},
|
||||
{
|
||||
"section": "[extension] Strikethrough",
|
||||
"html": "<p>This ~~has a</p>\n<p>new paragraph~~.</p>",
|
||||
"markdown": "This ~~has a\n\nnew paragraph~~.",
|
||||
"example": 492
|
||||
},
|
||||
{
|
||||
"section": "[extension] Autolinks",
|
||||
"html": "<p><a href=\"http://www.commonmark.org\">www.commonmark.org</a></p>",
|
||||
"markdown": "www.commonmark.org",
|
||||
"example": 621
|
||||
},
|
||||
{
|
||||
"section": "[extension] Autolinks",
|
||||
"html": "<p>Visit <a href=\"http://www.commonmark.org/help\">www.commonmark.org/help</a> for more information.</p>",
|
||||
"markdown": "Visit www.commonmark.org/help for more information.",
|
||||
"example": 622
|
||||
},
|
||||
{
|
||||
"section": "[extension] Autolinks",
|
||||
"html": "<p>Visit <a href=\"http://www.commonmark.org\">www.commonmark.org</a>.</p>\n<p>Visit <a href=\"http://www.commonmark.org/a.b\">www.commonmark.org/a.b</a>.</p>",
|
||||
"markdown": "Visit www.commonmark.org.\n\nVisit www.commonmark.org/a.b.",
|
||||
"example": 623
|
||||
},
|
||||
{
|
||||
"section": "[extension] Autolinks",
|
||||
"html": "<p><a href=\"http://www.google.com/search?q=Markup+(business)\">www.google.com/search?q=Markup+(business)</a></p>\n<p><a href=\"http://www.google.com/search?q=Markup+(business)\">www.google.com/search?q=Markup+(business)</a>))</p>\n<p>(<a href=\"http://www.google.com/search?q=Markup+(business)\">www.google.com/search?q=Markup+(business)</a>)</p>\n<p>(<a href=\"http://www.google.com/search?q=Markup+(business)\">www.google.com/search?q=Markup+(business)</a></p>",
|
||||
"markdown": "www.google.com/search?q=Markup+(business)\n\nwww.google.com/search?q=Markup+(business)))\n\n(www.google.com/search?q=Markup+(business))\n\n(www.google.com/search?q=Markup+(business)",
|
||||
"example": 624
|
||||
},
|
||||
{
|
||||
"section": "[extension] Autolinks",
|
||||
"html": "<p><a href=\"http://www.google.com/search?q=(business))+ok\">www.google.com/search?q=(business))+ok</a></p>",
|
||||
"markdown": "www.google.com/search?q=(business))+ok",
|
||||
"example": 625
|
||||
},
|
||||
{
|
||||
"section": "[extension] Autolinks",
|
||||
"html": "<p><a href=\"http://www.google.com/search?q=commonmark&hl=en\">www.google.com/search?q=commonmark&hl=en</a></p>\n<p><a href=\"http://www.google.com/search?q=commonmark\">www.google.com/search?q=commonmark</a>&hl;</p>",
|
||||
"markdown": "www.google.com/search?q=commonmark&hl=en\n\nwww.google.com/search?q=commonmark&hl;",
|
||||
"example": 626
|
||||
},
|
||||
{
|
||||
"section": "[extension] Autolinks",
|
||||
"html": "<p><a href=\"http://www.commonmark.org/he\">www.commonmark.org/he</a><lp</p>",
|
||||
"markdown": "www.commonmark.org/he<lp",
|
||||
"example": 627
|
||||
},
|
||||
{
|
||||
"section": "[extension] Autolinks",
|
||||
"html": "<p><a href=\"http://commonmark.org\">http://commonmark.org</a></p>\n<p>(Visit <a href=\"https://encrypted.google.com/search?q=Markup+(business)\">https://encrypted.google.com/search?q=Markup+(business)</a>)</p>\n<p>Anonymous FTP is available at <a href=\"ftp://foo.bar.baz\">ftp://foo.bar.baz</a>.</p>",
|
||||
"markdown": "http://commonmark.org\n\n(Visit https://encrypted.google.com/search?q=Markup+(business))\n\nAnonymous FTP is available at ftp://foo.bar.baz.",
|
||||
"example": 628
|
||||
},
|
||||
{
|
||||
"section": "[extension] Autolinks",
|
||||
"html": "<p><a href=\"mailto:foo@bar.baz\">foo@bar.baz</a></p>",
|
||||
"markdown": "foo@bar.baz",
|
||||
"example": 629
|
||||
},
|
||||
{
|
||||
"section": "[extension] Autolinks",
|
||||
"html": "<p>hello@mail+xyz.example isn't valid, but <a href=\"mailto:hello+xyz@mail.example\">hello+xyz@mail.example</a> is.</p>",
|
||||
"markdown": "hello@mail+xyz.example isn't valid, but hello+xyz@mail.example is.",
|
||||
"example": 630
|
||||
},
|
||||
{
|
||||
"section": "[extension] Autolinks",
|
||||
"html": "<p><a href=\"mailto:a.b-c_d@a.b\">a.b-c_d@a.b</a></p>\n<p><a href=\"mailto:a.b-c_d@a.b\">a.b-c_d@a.b</a>.</p>\n<p>a.b-c_d@a.b-</p>\n<p>a.b-c_d@a.b_</p>",
|
||||
"markdown": "a.b-c_d@a.b\n\na.b-c_d@a.b.\n\na.b-c_d@a.b-\n\na.b-c_d@a.b_",
|
||||
"example": 631
|
||||
},
|
||||
{
|
||||
"section": "[extension] Disallowed Raw HTML",
|
||||
"html": "<p><strong> <title> <style> <em></p>\n<blockquote>\n <xmp> is disallowed. <XMP> is also disallowed.\n</blockquote>",
|
||||
"markdown": "<strong> <title> <style> <em>\n\n<blockquote>\n <xmp> is disallowed. <XMP> is also disallowed.\n</blockquote>",
|
||||
"example": 653,
|
||||
"shouldFail": true
|
||||
}
|
||||
]
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
<ul>
|
||||
<li>This should be</li>
|
||||
<li>An unordered list</li>
|
||||
</ul>
|
||||
|
||||
<ol>
|
||||
<li>This should be</li>
|
||||
<li>An unordered list</li>
|
||||
</ol>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
* This should be
|
||||
* An unordered list
|
||||
|
||||
1. This should be
|
||||
2. An unordered list
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
<p>hello world
|
||||
<a href="http://example.com">http://example.com</a>
|
||||
</p>
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
hello world
|
||||
<http://example.com>
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
<p>(See <a href="https://www.example.com/fhqwhgads">https://www.example.com/fhqwhgads</a>.)</p>
|
||||
|
||||
<p>((<a href="http://foo.com">http://foo.com</a>))</p>
|
||||
|
||||
<p>((<a href="http://foo.com">http://foo.com</a>.))</p>
|
||||
|
||||
<p><a href="HTTP://FOO.COM">HTTP://FOO.COM</a></p>
|
||||
|
||||
<p><a href="hTtP://fOo.CoM">hTtP://fOo.CoM</a></p>
|
||||
|
||||
<p><del><a href="mailto:hello@email.com">hello@email.com</a></del></p>
|
||||
|
||||
<p><strong><a href="mailto:me@example.com">me@example.com</a></strong></p>
|
||||
|
||||
<p><strong><a href="mailto:test@test.com">test@test.com</a></strong></p>
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
(See https://www.example.com/fhqwhgads.)
|
||||
|
||||
((http://foo.com))
|
||||
|
||||
((http://foo.com.))
|
||||
|
||||
HTTP://FOO.COM
|
||||
|
||||
hTtP://fOo.CoM
|
||||
|
||||
~~hello@email.com~~
|
||||
|
||||
**me@example.com**
|
||||
|
||||
__test@test.com__
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
<p>This fails in markdown.pl and upskirt:</p>
|
||||
|
||||
<ul><li>hello<blockquote><p>world</p></blockquote></li></ul>
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
This fails in markdown.pl and upskirt:
|
||||
|
||||
* hello
|
||||
> world
|
||||
|
|
@ -0,0 +1 @@
|
|||
<p>A<br>B</p>
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
---
|
||||
breaks: true
|
||||
gfm: true
|
||||
---
|
||||
A
|
||||
B
|
||||
|
|
@ -0,0 +1 @@
|
|||
<p><a href="/url">hi</a></p>
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
[hi]
|
||||
|
||||
[HI]: /url
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
<p><code>someone@example.com</code></p>
|
||||
|
||||
<p>``<em>test`</em></p>
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
`someone@example.com`
|
||||
|
||||
``*test`*
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
<blockquote>
|
||||
<p>hello
|
||||
[1]: hello</p>
|
||||
</blockquote>
|
||||
|
||||
<hr>
|
||||
|
||||
<blockquote>
|
||||
<p>hello
|
||||
[2]: hello</p>
|
||||
</blockquote>
|
||||
|
||||
|
||||
<ul>
|
||||
<li>hello</li>
|
||||
<li>[3]: hello</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<ul>
|
||||
<li>hello</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<blockquote>
|
||||
<p>foo
|
||||
bar
|
||||
[5]: foo
|
||||
bar</p>
|
||||
</blockquote>
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
> hello
|
||||
> [1]: hello
|
||||
|
||||
* * *
|
||||
|
||||
> hello
|
||||
[2]: hello
|
||||
|
||||
|
||||
* hello
|
||||
* [3]: hello
|
||||
|
||||
|
||||
* hello
|
||||
[4]: hello
|
||||
|
||||
|
||||
> foo
|
||||
> bar
|
||||
[5]: foo
|
||||
> bar
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<p>Already linked: <a href="http://example.com/">http://example.com/</a>.</p>
|
||||
|
||||
<p>Already linked: <a href="http://example.com/">http://example.com/</a>.</p>
|
||||
|
||||
<p>Already linked: <a href="http://example.com/"><strong>http://example.com/</strong></a>.</p>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<p>Already linked: <a href="http://example.com/">http://example.com/</a>.</p>
|
||||
|
||||
Already linked: [http://example.com/](http://example.com/).
|
||||
|
||||
Already linked: <a href="http://example.com/">**http://example.com/**</a>.
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
<p><em>123</em></p>
|
||||
|
||||
<p><em>123</em></p>
|
||||
|
||||
<p><em>12</em></p>
|
||||
|
||||
<p><em>12</em></p>
|
||||
|
||||
<p><em>1</em></p>
|
||||
|
||||
<p><em>1</em></p>
|
||||
|
||||
<p>__</p>
|
||||
|
||||
<p>**</p>
|
||||
|
||||
<p>_123 _</p>
|
||||
|
||||
<p>*123 *</p>
|
||||
|
||||
<p>_ 123_</p>
|
||||
|
||||
<p><em>1_</em></p>
|
||||
|
||||
<p><em>1*</em></p>
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
_123_
|
||||
|
||||
*123*
|
||||
|
||||
_12_
|
||||
|
||||
*12*
|
||||
|
||||
_1_
|
||||
|
||||
*1*
|
||||
|
||||
__
|
||||
|
||||
**
|
||||
|
||||
_123 _
|
||||
|
||||
*123 *
|
||||
|
||||
_ 123_
|
||||
|
||||
_1__
|
||||
|
||||
*1**
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
<ul>
|
||||
<li>italic<ul>
|
||||
<li><a href="https://www.google.com"><em>named link</em></a></li>
|
||||
<li><em><a href="https://www.google.com">named link</a></em></li>
|
||||
<li><a href="https://www.google.com"><em>named link</em></a></li>
|
||||
<li><em><a href="https://www.google.com">named link</a></em></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>bold<ul>
|
||||
<li><a href="https://www.google.com"><strong>named link</strong></a></li>
|
||||
<li><strong><a href="https://www.google.com">named link</a></strong></li>
|
||||
<li><a href="https://www.google.com"><strong>named link</strong></a></li>
|
||||
<li><strong><a href="https://www.google.com">named link</a></strong></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>bold italic<ul>
|
||||
<li><a href="https://www.google.com"><strong><em>named link</em></strong></a></li>
|
||||
<li><strong><em><a href="https://www.google.com">named link</a></em></strong></li>
|
||||
<li><a href="https://www.google.com"><strong><em>named link</em></strong></a></li>
|
||||
<li><strong><em><a href="https://www.google.com">named link</a></em></strong></li>
|
||||
<li><a href="https://www.google.com"><em><strong>named link</strong></em></a></li>
|
||||
<li><a href="https://www.google.com"><strong><em>named link</em></strong></a></li>
|
||||
<li><strong><em><a href="https://www.google.com">named link</a></em></strong></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>code<ul>
|
||||
<li><a href="https://www.google.com"><code>named link</code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>code italic<ul>
|
||||
<li><em><a href="https://www.google.com"><code>named link</code></a></em></li>
|
||||
<li><a href="https://www.google.com"><em><code>named link</code></em></a></li>
|
||||
<li><em><a href="https://www.google.com"><code>named link</code></a></em></li>
|
||||
<li><a href="https://www.google.com"><em><code>named link</code></em></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>code bold<ul>
|
||||
<li><strong><a href="https://www.google.com"><code>named link</code></a></strong></li>
|
||||
<li><a href="https://www.google.com"><strong><code>named link</code></strong></a></li>
|
||||
<li><strong><a href="https://www.google.com"><code>named link</code></a></strong></li>
|
||||
<li><a href="https://www.google.com"><strong><code>named link</code></strong></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>code bold italic<ul>
|
||||
<li><a href="https://www.google.com"><strong><em><code>named link</code></em></strong></a></li>
|
||||
<li><strong><em><a href="https://www.google.com"><code>named link</code></a></em></strong></li>
|
||||
<li><a href="https://www.google.com"><strong><em><code>named link</code></em></strong></a></li>
|
||||
<li><strong><em><a href="https://www.google.com"><code>named link</code></a></em></strong></li>
|
||||
<li><a href="https://www.google.com"><em><strong><code>named link</code></strong></em></a></li>
|
||||
<li><a href="https://www.google.com"><strong><em><code>named link</code></em></strong></a></li>
|
||||
<li><strong><em><a href="https://www.google.com"><code>named link</code></a></em></strong></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
- italic
|
||||
- [*named link*][some-url]
|
||||
- *[named link][some-url]*
|
||||
- [_named link_][some-url]
|
||||
- _[named link][some-url]_
|
||||
- bold
|
||||
- [**named link**][some-url]
|
||||
- **[named link][some-url]**
|
||||
- [__named link__][some-url]
|
||||
- __[named link][some-url]__
|
||||
- bold italic
|
||||
- [***named link***][some-url]
|
||||
- ***[named link][some-url]***
|
||||
- [___named link___][some-url]
|
||||
- ___[named link][some-url]___
|
||||
- [*__named link__*][some-url]
|
||||
- [__*named link*__][some-url]
|
||||
- __*[named link][some-url]*__
|
||||
- code
|
||||
- [`named link`][some-url]
|
||||
- code italic
|
||||
- *[`named link`][some-url]*
|
||||
- [*`named link`*][some-url]
|
||||
- _[`named link`][some-url]_
|
||||
- [_`named link`_][some-url]
|
||||
- code bold
|
||||
- **[`named link`][some-url]**
|
||||
- [**`named link`**][some-url]
|
||||
- __[`named link`][some-url]__
|
||||
- [__`named link`__][some-url]
|
||||
- code bold italic
|
||||
- [***`named link`***][some-url]
|
||||
- ***[`named link`][some-url]***
|
||||
- [___`named link`___][some-url]
|
||||
- ___[`named link`][some-url]___
|
||||
- [*__`named link`__*][some-url]
|
||||
- [__*`named link`*__][some-url]
|
||||
- __*[`named link`][some-url]*__
|
||||
|
||||
[some-url]: https://www.google.com
|
||||
|
|
@ -0,0 +1 @@
|
|||
<p><em>test</em>. <em>test</em>: <em>test</em>! <em>test</em>? <em>test</em>-</p>
|
||||
|
|
@ -0,0 +1 @@
|
|||
_test_. _test_: _test_! _test_? _test_-
|
||||
|
|
@ -0,0 +1 @@
|
|||
<p>></p>
|
||||
|
|
@ -0,0 +1 @@
|
|||
\>
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
<h3 id="heading-with-a-link">Heading with a <a href="http://github.com/">link</a></h3>
|
||||
|
||||
<h3 id="heading-with-some-italic-text">Heading with some <em>italic text</em></h3>
|
||||
|
||||
<h3 id="or-some-strong">Or some <strong>strong</strong></h3>
|
||||
|
||||
<p>(which doesn't really make any difference, here)</p>
|
||||
|
||||
<h3 id="or-even-code">Or even <code>code</code></h3>
|
||||
|
||||
<h3 id="what-about-strikethrough">What about <del>strikethrough</del></h3>
|
||||
|
||||
<h2 id="and-a-ref-link">And a ref <a href="/some/url" title="link to nowhere">link</a></h2>
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
### Heading with a [link](http://github.com/)
|
||||
|
||||
### Heading with some _italic text_
|
||||
|
||||
### Or some **strong**
|
||||
(which doesn't really make any difference, here)
|
||||
|
||||
### Or even `code`
|
||||
|
||||
### What about ~~strikethrough~~
|
||||
|
||||
## And a ref [link][destination]
|
||||
|
||||
[destination]: /some/url "link to nowhere"
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
<ul>
|
||||
<li>hello
|
||||
world</li>
|
||||
<li>how
|
||||
are</li>
|
||||
</ul>
|
||||
|
||||
<hr>
|
||||
|
||||
<p>you today?</p>
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
* hello
|
||||
world
|
||||
* how
|
||||
are
|
||||
* * *
|
||||
you today?
|
||||
|
|
@ -0,0 +1,57 @@
|
|||
<h3 id="example-1">Example 1</h3>
|
||||
|
||||
<!-- comment -->
|
||||
|
||||
<h3 id="example-2">Example 2</h3>
|
||||
|
||||
<!---->
|
||||
|
||||
<h3 id="example-3">Example 3</h3>
|
||||
|
||||
<!-- -->
|
||||
|
||||
<h3 id="example-4">Example 4</h3>
|
||||
|
||||
<!-- - -->
|
||||
|
||||
<h3 id="example-5">Example 5</h3>
|
||||
|
||||
<!-- -- -->
|
||||
|
||||
<h3 id="example-6">Example 6</h3>
|
||||
|
||||
<!-- --->
|
||||
|
||||
<h3 id="example-7">Example 7</h3>
|
||||
|
||||
<!----->
|
||||
|
||||
<h3 id="example-8">Example 8</h3>
|
||||
|
||||
<!------>
|
||||
|
||||
<h3 id="example-9">Example 9</h3>
|
||||
|
||||
<!-- My favorite operators are > and <!-->
|
||||
|
||||
<h3 id="example-10">Example 10</h3>
|
||||
|
||||
<!-- multi
|
||||
line
|
||||
comment
|
||||
-->
|
||||
|
||||
<h3 id="example-11">Example 11</h3>
|
||||
|
||||
<!-- indented comment -->
|
||||
|
||||
<pre><code><!-- too much indentation -->
|
||||
</code></pre>
|
||||
|
||||
<h3 id="example-12">Example 12</h3>
|
||||
|
||||
<p><!--> not a comment --></p>
|
||||
|
||||
<p><!---> not a comment --></p>
|
||||
|
||||
<!-- <!-- not a comment? --> -->
|
||||
|
|
@ -0,0 +1,56 @@
|
|||
### Example 1
|
||||
|
||||
<!-- comment -->
|
||||
|
||||
### Example 2
|
||||
|
||||
<!---->
|
||||
|
||||
### Example 3
|
||||
|
||||
<!-- -->
|
||||
|
||||
### Example 4
|
||||
|
||||
<!-- - -->
|
||||
|
||||
### Example 5
|
||||
|
||||
<!-- -- -->
|
||||
|
||||
### Example 6
|
||||
|
||||
<!-- --->
|
||||
|
||||
### Example 7
|
||||
|
||||
<!----->
|
||||
|
||||
### Example 8
|
||||
|
||||
<!------>
|
||||
|
||||
### Example 9
|
||||
|
||||
<!-- My favorite operators are > and <!-->
|
||||
|
||||
### Example 10
|
||||
|
||||
<!-- multi
|
||||
line
|
||||
comment
|
||||
-->
|
||||
|
||||
### Example 11
|
||||
|
||||
<!-- indented comment -->
|
||||
|
||||
<!-- too much indentation -->
|
||||
|
||||
### Example 12
|
||||
|
||||
<!--> not a comment -->
|
||||
|
||||
<!---> not a comment -->
|
||||
|
||||
<!-- <!-- not a comment? --> -->
|
||||
|
|
@ -0,0 +1 @@
|
|||
<img src='sdfg'>
|
||||
|
|
@ -0,0 +1 @@
|
|||
<img src='sdfg'>
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
<p>Image</p>
|
||||
<p>Image</p>
|
||||
<p>Image</p>
|
||||
<p>Image</p>
|
||||
<p>Image</p>
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
---
|
||||
sanitize: true
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
)
|
||||
|
||||
)
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue