除了 Markdown 编辑器,你还需要会用程序来处理它-阿里云开发者社区

开发者社区> 知与谁同> 正文

除了 Markdown 编辑器,你还需要会用程序来处理它

简介:
+关注继续查看

前言

随着 wordpress 和静态网站的流行,markdown 被用的越来越多。我们已经介绍过很多 Markdown 编辑器,但是有时候你也需要用程序来处理 Markdown 文本。

markdown 是一个面向写作的语法引擎,markdown 的最终目的都是解析成 html 用于网页浏览,所以它兼容 html 语法,即你可以在 markdown 文档中使用原生的 html 标签。

markdown 解析器

开发静态网站生成器的时候都会采用一种叫 front matter 的格式进行网站内容写在类似下面的格式


  1. ---
  2. title: 玩转markdown,你需要用到这几个工具
  3. date: 2016-08-14 16:44:54
  4. image: /img/pencils-762555_640.jpg
  5. ---
  6. ## 前言
  7. 随着wordpress和静态网站的流行,markdown被用的越来越多。...

当进行网站生成的时候需要进行 markdown 解析,然后渲染成 html 页面,那用什么工具进行解析呢?

marked

marked 是最早用 node.js 开发的 markdown 解析器,同时提供 CLI 命令调用和 node.js API 调用。

CLI 调用代码示例


  1. $ marked -o hello.html
  2. hello world
  3. ^D
  4. $ cat hello.html
  5. <p>hello world</p>

API调用示例


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

这些都是一些通用的功能,但是 marked 还支持代码高亮,通过使用 highlight.js

使用 highlight.js 进行代码高亮相信大家都用到过,可能大家不知道是 highlight.js 还支持 API 方式调用,下面的代码会配置 marked 使用 highlight.js 进行代码高亮:


  1. marked.setOptions({
  2. highlight: function (code, lang) {
  3. var res;
  4. if (lang) {
  5. res = hljs.highlight(lang, code, true).value;
  6. } else {
  7. res = hljs.highlightAuto(code).value;
  8. }
  9. return res;
  10. }
  11. });

生成的代码已经包含代码高亮标签,最后只需要引入 highlight.js 的主题就能显示了,highlight.js 所有的颜色主题都在这里

markdown-js

markdown-js 也是一款使用 node.js 开发的 markdown 解析器,基本用法和 marked 差不多,但是文档里面好像没有提到像 marked 一样进行代码高亮生成的接口,有兴趣的同学自己找找吧。

markdown 生成器

to-markdown

什么是 markdown 生成器,就是根据 html 标签生成 markdown 文件。

github 上面 markdown 生成器 star 数最高的是 to-markdown。

简单的代码示例


  1. var toMarkdown = require('to-markdown');
  2. toMarkdown('<h1>Hello world!</h1>');

to-markdown 最近进行了更新,增加了对 gfm 的兼容,gfm 就是 git flavored markdown 的意思, 是 github 对 markdown 语法进行的扩展。

使用 gfm 的示例


  1. toMarkdown('<del>Hello world!</del>', { gfm: true });

那这个 to-markdown 有什么用呢?

举个简单的例子,假如我想开发一个简单的 RSS 阅读器,但是我又不想跳转到目标网站去阅读,因为不同的网站风格不一,导致不一致的阅读体验。

怎么办呢?那就把网站内容抓取下来,然后用 to-markdown 生成 markdown 文件,然后使用自己的模板样式进行统一渲染。

当然去除广告只是一个 side effect。

heckyesmarkdown

除了 to-markdown 之外还有一个比较好用的 API: heckyesmarkdown,这个项目使用了 php-readability,提高文章的可读性。

可惜 heckyesmarkdown 没有开源出来,这个项目有点古老,估计那个时候 github 还没流行起来。

heckyesmarkdow 对中文的支持不是非常友好,如果想抓取中文站还是使用 to-markdown 比较靠谱一点。

front matter

markdown 写文章确实很方便,简单容易上手,但是 markdown 不能保存元数据,例如作者,日期,类型这样的结构化的数据,如果都生成 html 标签的话提取的时候又稍微麻烦了点, 还得借助 cheerio 才能完成。

所以,为了能方便的保存文章的元数据,几乎所有的静态网站生成器都使用 front matter 格式来保存文章。

front matter 文件通常分为头部和正文部分,头部一般使用 yamltoml 和 json 三种格式,front matter 解析工具需要识别这三种格式的文件头。正文部分就是普通的 markdown 内容。

front-matter

front-matter 也是用 node.js 开发的,相比 markdown 解析器来说,fornt-matter 解析器要简单很多。

示例文件 example.md


  1. ---
  2. title: Just hack'n
  3. description: Nothing to see here
  4. ---
  5. This is some text about some stuff that happened sometime ago

解析代码


  1. var fs = require('fs')
  2. , fm = require('front-matter')
  3. fs.readFile('./example.md', 'utf8', function(err, data){
  4. if (err) throw err
  5. var content = fm(data)
  6. console.log(content)
  7. })

解析结果


  1. {
  2. attributes: {
  3. title: 'Just hack\'n',
  4. description: 'Nothing to see here'
  5. },
  6. body: '\nThis is some text about some stuff that happened sometime ago',
  7. frontmatter: 'title: Just hack\'n\ndescription: Nothing to see here'
  8. }

front matter 虽然格式看起来不太统一,却是对 markdown 强有力的补充。

原文发布时间为:2016-08-27

本文来自云栖社区合作伙伴“Linux中国”

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
如何在函数计算中使用 Node.js 处理 multipart 文件上传请求
## 前言 web 开发中我们经常会允许用户通过 HTTP POST 请求上传文档到服务器,如何使用函数计算来做文件上传服务呢?下面我们使用 nodejs 来实现一个文件上传的案例: 我们知道浏览器中上传文档通常会使用 `multipart` `form-data` 来多文件同时上传文件。 例如,我们可以使用curl来做这个测试模拟上传两个文件: `test.txt` 和 `inde
1600 0
如何在函数计算中使用 Node.js 处理 multipart 文件上传请求
web 开发中我们经常会允许用户通过 HTTP POST 请求上传文档到服务器,本文将介绍在函数计算中基于 node.js 使用 multipart form-data 来实现文件上传服务。
2706 0
PreparedStatement批量处理的一个Framework(原创)
场景:批量进行DML操作,但涉及的表不同,不能使用executeBatch()需求:(1)如果DML中有一个错误时,要全部回滚;(2)如果全部正确,要全部执行;解决方案: package jdbc; import java.
997 0
hive 动态分区(Dynamic Partition)异常处理
Changing Hive Dynamic Partition Limits Symptoms: Hive enforces limits on the number of dynamic partitions that it creates.
1254 0
分享一个 markdown 编辑器 - Mditor
## 只求极致 [ **M** ] arkdown + E [ **ditor** ] = **Mditor** [![version](https://badge.fury.io/js/mditor.svg)](http://badge.fury.io/js/mditor) Mditor 是一个简洁、易于集成、方便扩展、期望舒服的编写 markdown 的编辑器,仅
3704 0
+关注
10077
文章
2994
问答
文章排行榜
最热
最新
相关电子书
更多
《2021云上架构与运维峰会演讲合集》
立即下载
《零基础CSS入门教程》
立即下载
《零基础HTML入门教程》
立即下载