markdown-utils中文文档|markdown-utils js中文教程|解析

npm npmdoc 3年前 (2021-12-25) 591次浏览

markdown-utils中文文档|markdown-utils js中文教程|解析

安装命令:npm i markdown-utils

降价工具 NPM 版本 NPM 每月下载量 NPM 总下载量 Linux 构建状态

用于创建格式一致的降价代码片段的小助手。

请考虑关注该项目的作者Jon Schlinkert,并考虑为该项目加星以表达您的 ❤️ 和支持。

安装

使用npm安装

$ npm install --save markdown-utils

用法

const mdu = require('markdown-utils');

应用程序接口

.blockquote

创建一个 Markdown 格式的块引用。

参数

  • str {细绳}

例子

utils.blockquote('This is a blockquote');
//=> '> This is a blockquote'

。代码

创建一个 Markdown 格式的<code></code>片段。

参数

  • str {细绳}

例子

utils.code('const foo = bar;');
//=> '`const foo = bar;`'

.del

创建降价格式的删除文本:~~text~~.

参数

  • str {细绳}

例子

utils.del('text');
//=> '~~text~~'

.em

创建一个 Markdown 格式的 em。

参数

  • str {细绳}

例子

utils.em('This is emphasized');
//=> '_This is emphasized_'

。H

创建降价格式的标题。

参数

  • str {细绳}
  • level {数字}

例子

utils.h(1, 'This is a heading');
//=> '# This is a heading'

.h1

创建降价格式的 h1 标题。

参数

  • str {细绳}

例子

utils.h1('This is a heading');
//=> '# This is a heading'

.h2

创建降价格式的 h2 标题。

参数

  • str {细绳}

例子

utils.h2('This is a heading');
//=> '## This is a heading'

.h3

创建一个 Markdown 格式的 h3 标题。

参数

  • str {细绳}

例子

utils.h3('This is a heading');
//=> '### This is a heading'

.h4

创建一个 Markdown 格式的 h4 标题。

参数

  • str {细绳}

例子

utils.h4('This is a heading');
//=> '#### This is a heading'

.h5

创建一个 Markdown 格式的 h5 标题。

参数

  • str {细绳}

例子

utils.h5('This is a heading');
//=> '##### This is a heading'

.h6

创建一个 Markdown 格式的 h6 标题。

参数

  • str {细绳}

例子

utils.h6('This is a heading');
//=> '###### This is a heading'

。标题

创建降价格式的标题。

参数

  • str {细绳}
  • level {数字}

例子

utils.heading('This is a heading', 1);
//=> '# This is a heading'

.hr

创建降价格式的水平线。

参数

  • str {String}:要使用的替代字符串。默认是***避免与---通常用于前质的碰撞

例子

utils.hr();
//=> '***'

。关联

从给定的值创建一个 Markdown 格式的链接。

参数

  • anchor {细绳}
  • href {细绳}
  • title {细绳}

例子

utils.link('fs-utils', 'https://github.com/assemble/fs-utils', 'hover title');
//=> [fs-utils](https://github.com/assemble/fs-utils "hover title")

。锚

从给定的值创建一个 Markdown 格式的锚链接。

参数

  • anchor {细绳}
  • href {细绳}
  • title {细绳}

例子

utils.anchor('embed', 'assemble/handlebars-helpers/lib/code.js', 25, 'v0.6.0');
//=> (https://github.com/assemble/handlebars-helpers/blob/v0.6.0/lib/helpers/code.js#L25)

。参考

从给定的值创建一个 Markdown 格式的参考链接。

参数

  • id {细绳}
  • url {细绳}
  • title {细绳}

例子

utils.reference('template', 'https://github/jonschlinkert/template', 'Make stuff!');
//=> [template]: https://github/jonschlinkert/template "Make stuff!"

。图片

从给定的值创建降价格式的图像。

参数

  • alt {细绳}
  • src {细绳}
  • title {细绳}

例子

utils.image(alt, src);
//=> ![Build Status](https://travis-ci.org/jonschlinkert/template.svg)
 
utils.image(alt, src, title);
//=> ![Build Status](https://travis-ci.org/jonschlinkert/template.svg "This is title of image!")

。徽章

创建降价格式的徽章。

参数

  • alt {细绳}
  • img_url {细绳}
  • url {细绳}

例子

utils.badge(alt, img_url, url);
//=> [![Build Status](https://travis-ci.org/jonschlinkert/template.svg)](https://travis-ci.org/jonschlinkert/template)

.li

返回一个函数来生成一个纯文本/降价列表项,允许为后续调用缓存选项。

参数

  • options {细绳}
  • nobullet {Boolean}:如果您只想要列表 iten 和 identation,但没有项目符号,则传递 true。
  • indent {String}:要使用的前导缩进量。默认是“.
  • chars {String|Array} : 如果传入一个字符串,fill-range将用于生成一个项目符号数组(访问fill-range查看所有选项。)或者直接将一个项目符号、数字、字母或其他字符的数组传递给用于每个列表项。默认['-', '*', '+', '~']
  • fn {Function}:传递一个函数fill-range以在项目生成时修改项目符号。

例子

const li = listitem(options);
 
li(0, 'Level 0 list item');
//=> '- Level 0 list item'
 
li(1, 'Level 1 list item');
//=> '  * Level 1 list item'
 
li(2, 'Level 2 list item');
//=> '    + Level 2 list item'

.pre

<pre><code></code></pre>使用或不使用 lang创建一个 Markdown 格式的片段。

结果是:

参数

  • str {细绳}
  • language {细绳}

例子

utils.pre('const foo = bar;');
<pre>
const foo = bar;
</pre>

.gfm

创建带有或不带有lang.

结果是:


参数

  • str {细绳}
  • language {细绳}

例子

utils.gfm('const foo = bar;', 'js');
const foo = bar;

。强的

创建降价格式的粗体文本。

参数

  • str {细绳}

例子

utils.strong('This is bold');
//=> '**This is bold**'

。去做

创建一个 Markdown 格式的待办事项。

参数

  • str {细绳}

例子

utils.todo('this is a todo.');
//=> '- [ ] this is a todo'
 
utils.todo('this is a completed todo.', true);
//=> '- [x] this is a todo'

关于

贡献

拉取请求和星星总是受欢迎的。对于错误和功能请求,请创建问题

运行测试

运行和审查单元测试是熟悉库及其 API 的好方法。您可以使用以下命令安装依赖项并运行测试:

$ npm install && npm test
构建文档

(本项目的 readme.md 是由verb生成的,请不要直接编辑 readme。对 readme 的任何更改都必须在.verb.md readme 模板中进行。)

要生成自述文件,请运行以下命令:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

相关项目

您可能还对这些项目感兴趣:

贡献者

提交 贡献者
49 琼施林克特
12 adjohnson916

作者

乔恩·施林克特

执照

版权所有 © 2018,乔恩·施林克特MIT 许可发布


此文件由verb-generate-readme v0.6.0 于2018 年7 月5 日生成

项目贡献人员列表:


极客公园 , 版权所有丨如未注明 , 均为原创丨本网站采用BY-NC-SA协议进行授权
转载请注明原文链接:markdown-utils中文文档|markdown-utils js中文教程|解析
喜欢 (0)
.excerpt .focus {display:none}