在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称(OpenSource Name):jonschlinkert/remarkable开源软件地址(OpenSource Url):https://github.com/jonschlinkert/remarkable开源编程语言(OpenSource Language):JavaScript 99.4%开源软件介绍(OpenSource Introduction):remarkable
Installnode.js: npm install remarkable --save browser (CDN): Usageimport { Remarkable } from 'remarkable';
var md = new Remarkable();
console.log(md.render('# Remarkable rulezz!'));
// => <h1>Remarkable rulezz!</h1> or with commonjs const { Remarkable } = require('remarkable');
var md = new Remarkable();
console.log(md.render('# Remarkable rulezz!'));
// => <h1>Remarkable rulezz!</h1> If installed globally with cat myfile.md | remarkable
remarkable --file myfile.md
# get options
remarkable -h DocumentationSee the docs directory for documentation on the following topics: OptionsBy default, remarkable is configured to be similar to GFM, but with HTML disabled. This is easy to change if you prefer different settings. There are two ways to define options. constructorDefine options in the constructor: // Actual default values
var md = new Remarkable({
html: false, // Enable HTML tags in source
xhtmlOut: false, // Use '/' to close single tags (<br />)
breaks: false, // Convert '\n' in paragraphs into <br>
langPrefix: 'language-', // CSS language prefix for fenced blocks
// Enable some language-neutral replacement + quotes beautification
typographer: false,
// Double + single quotes replacement pairs, when typographer enabled,
// and smartquotes on. Set doubles to '«»' for Russian, '„“' for German.
quotes: '“”‘’',
// Highlighter function. Should return escaped HTML,
// or '' if the source string is not changed
highlight: function (/*str, lang*/) { return ''; }
});
console.log(md.render('# Remarkable rulezz!'));
// => <h1>Remarkable rulezz!</h1> .setOr define options via the import { Remarkable } from 'remarkable';
var md = new Remarkable();
md.set({
html: true,
breaks: true
}); Note: To achieve the best possible performance, don't modify a PresetsRemarkable offers some "presets" as a convenience to quickly enable/disable active syntax rules and options for common use cases. commonmarkEnable strict CommonMark mode with the import { Remarkable } from 'remarkable';
var md = new Remarkable('commonmark'); fullEnable all available rules (but still with default options, if not set): import { Remarkable } from 'remarkable';
var md = new Remarkable('full');
// Or with options:
var md = new Remarkable('full', {
html: true,
typographer: true
}); Syntax highlightingApply syntax highlighting to fenced code blocks with the import { Remarkable } from 'remarkable';
import hljs from 'highlight.js' // https://highlightjs.org/
// Actual default values
var md = new Remarkable({
highlight: function (str, lang) {
if (lang && hljs.getLanguage(lang)) {
try {
return hljs.highlight(lang, str).value;
} catch (err) {}
}
try {
return hljs.highlightAuto(str).value;
} catch (err) {}
return ''; // use external default escaping
}
}); Syntax extensionsEnabled by default: Disabled by default:
HEADS UP!: Experimental extensions can be changed later for something like Critic Markup, but you will still be able to use old-style rules via external plugins if you prefer. Manage rulesvar md = new Remarkable();
md.inline.ruler.enable([ 'ins', 'mark' ]);
md.block.ruler.disable([ 'table', 'footnote' ]);
// Enable everything
md = new Remarkable('full', {
html: true,
typographer: true,
});
//
// Manually enable rules, disabled by default:
//
var md = new Remarkable();
md.core.ruler.enable([
'abbr'
]);
md.block.ruler.enable([
'footnote',
'deflist'
]);
md.inline.ruler.enable([
'footnote_inline',
'ins',
'mark',
'sub',
'sup'
]); TypographerAlthough full-weight typographical replacements are language specific, import { Remarkable } from 'remarkable';
var md = new Remarkable({
typographer: true,
quotes: '“”‘’'
});
// Disable rules at all:
md.core.ruler.disable([ 'replacements', 'smartquotes' ]);
// Actual default replacements:
//
// '' → ‘’
// "" → “”. Set '«»' for Russian, '„“' for German, empty to disable
// (c) (C) → ©
// (tm) (TM) → ™
// (r) (R) → ®
// +- → ±
// (p) (P) -> §
// ... → … (also ?.... → ?.., !.... → !..)
// ???????? → ???, !!!!! → !!!, `,,` → `,`
// -- → –, --- → —
// Of course, you can also add your own rules or replace the defaults with something more advanced or specific to your language. PluginsEasily load plugins with the var md = new Remarkable();
md.use(plugin1)
.use(plugin2, opts)
.use(plugin3); Please refer to the plugin documentation to create your own plugins. linkify pluginAutoconvert URL-like text to links import { Remarkable } from 'remarkable';
import { linkify } from 'remarkable/linkify';
var md = new Remarkable().use(linkify); UMDUMD bundle provides linkify out of the box const { Remarkable, linkify, utils } = window.remarkable; References / ThanksBig thanks to John MacFarlane for his work on the CommonMark spec and reference implementations. His work saved us a lot of time during this project's development. Related Links:
Development / ModificationParser consists of several responsibility chains filled with rules. You can reconfigure any of them as you wish. Renderer also can be modified and extended. See source code to understand details. Pay attention to these properties: Remarkable.core
Remarkable.core.ruler
Remarkable.block
Remarkable.block.ruler
Remarkable.inline
Remarkable.inline.ruler
Remarkable.renderer
Remarkable.renderer.rules BenchmarkHere is result of CommonMark spec parse at Core i5 2.4 GHz (i5-4258U): $ benchmark/benchmark.js spec
Selected samples: (1 of 27)
> spec
Sample: spec.txt (110610 bytes)
> commonmark-reference x 40.42 ops/sec ±4.07% (51 runs sampled)
> current x 74.99 ops/sec ±4.69% (67 runs sampled)
> current-commonmark x 93.76 ops/sec ±1.23% (79 runs sampled)
> marked-0.3.2 x 22.92 ops/sec ±0.79% (41 runs sampled) As you can see, Authors
License |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论