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

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

[[170706]]

前言

随着 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 文件通常分为头部和正文部分,头部一般使用 yaml、toml 和 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.     attributes: { 
  2.         title: 'Just hack\'n'
  3.         description: 'Nothing to see here' 
  4.     }, 
  5.     body: '\nThis is some text about some stuff that happened sometime ago'
  6.     frontmatter: 'title: Just hack\'n\ndescription: Nothing to see here' 

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

 

责任编辑:庞桂玉 来源: Linux中国
相关推荐

2015-03-18 15:37:19

社交APP场景

2021-03-31 13:20:02

智慧城市物联网5G

2017-08-21 16:00:14

机器学习机器翻译

2015-11-06 10:21:50

2024-08-19 08:16:00

AI能源

2020-09-18 06:00:51

开源Markdown编辑器

2023-09-10 23:22:33

Zettlr笔记编辑器

2018-11-30 09:56:46

物联网智能空间网络架构

2018-06-29 10:52:07

PythonIDE编辑器

2023-06-01 07:50:42

JSDocTypeScriptAPI

2017-05-23 19:19:16

开源Markdown编辑器

2020-04-09 14:23:44

PythonMarkdown编辑器

2024-05-06 09:35:05

AI网关开源

2018-01-15 08:38:41

备份服务器企业

2021-10-27 14:55:57

Mark TextMarkdown编辑器

2018-09-20 22:04:01

2020-04-26 09:32:13

物联网安全技术

2017-12-11 17:14:56

ERP管理数字化

2021-10-21 10:58:03

Markdown编辑器

2016-08-02 10:35:40

LinuxMarkdown编辑器
点赞
收藏

51CTO技术栈公众号