Showdown.js 基于 JavaScript 的 MarkDown 语法解释工具 - 文章教程

Showdown.js 基于 JavaScript 的 MarkDown 语法解释工具

发布于 2019-08-17 字数 2798 浏览 2722 评论 0

Showdown.js 是一个基于 JavaScript 开发环境的 MarkDown 语法解释工具,能够支持服务端 Node.js 和客户端各大主流浏览器,基于 John Gruber 的原创作品。

安装Showdown.js

你可以访问 Showdown.js的Github地址,下载最新版的 Showdown.js 源文件,然后将 JS 文件和 CSS 文件引入到你的网页中。

<script src="js/showdown.min.js"></script>

如果你比较喜欢使用软件包管理器,那么你可以通过下面的命令安装

bower install showdown
npm install showdown

如果你嫌弃上面的方法都很繁琐,那么你可以使用免费的 CDN 加速,无需下载引入即可使用

https://cdn.rawgit.com/showdownjs/showdown/<version tag>/dist/showdown.min.js
https://cdnjs.cloudflare.com/ajax/libs/showdown/<version tag>/showdown.min.js

浏览器兼容

Showdown.js 能够在下面的浏览器中完美的运行:

  • Firefox 1.5 and 2.0
  • Chrome 12.0
  • Internet Explorer 6 and 7
  • Safari 2.0.4
  • Opera 8.54 and 9.10
  • Netscape 8.1.2
  • Konqueror 3.5.4

在理论上,对决将在任何支持 ECMA 262 第三版浏览器(JavaScript 1.5)。Showdown.js 并一定需要在浏览器中运行,能运行 JS 的地方都可以。

使用 Showdown.js 举例

配合 Node.js 在服务端使用

var showdown  = require('showdown'),
    converter = new showdown.Converter(),
    text      = '#hello, markdown!',
    html      = converter.makeHtml(text);

在浏览器中使用

var converter = new showdown.Converter(),
    text      = '#hello, markdown!',
    html      = converter.makeHtml(text);

上面的代码运行以后,应该生成下面的 HTML 代码

<h1 id="hellomarkdown">hello, markdown!</h1>

可选的插件扩展

通过扩展可加载附加功能来加载。(你可以在这里找到一个已知的对决的列表)

客户端扩展使用

<script src="showdown.js" /></script>
<script src="twitter-extension.js" /></script>
<script>
var converter = new showdown.Converter({
    extensions: 'twitter'
});
</script>

服务器端扩展使用

var showdown    = require('showdown'),
    myExtension = require('myExtension'),
    converter = new showdown.Converter({ extensions: ['myExtension'] });

更多配置参数请访问:https://github.com/showdownjs/showdown#options

相关链接

如果你对这篇文章有疑问,欢迎到本站 社区 发帖提问或使用手Q扫描下方二维码加群参与讨论,获取更多帮助。

扫码加入群聊

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

目前还没有任何评论,快来抢沙发吧!

关于作者

JSmiles

生命进入颠沛而奔忙的本质状态,并将以不断告别和相遇的陈旧方式继续下去。

2891 文章
评论
84935 人气
更多

推荐作者

伊面

文章 0 评论

白况

文章 0 评论

七禾

文章 0 评论

亢潮

文章 0 评论

悲念泪

文章 0 评论