玩转markdown 分享几个需要用到的工具(2)
to-markdown最近进行了更新,增加了对gfm的兼容,gfm就是git flavored markdown的意思, 是github对markdown语法进行了扩展。
使用gfm的示例
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
--- title: Just hack'n description: Nothing to see here --- This is some text about some stuff that happened sometime ago
解析代码
var fs = require('fs') , fm = require('front-matter') fs.readFile('./example.md', 'utf8', function(err, data){ if (err) throw err var content = fm(data) console.log(content) }) { attributes: { title: 'Just hack\'n', description: 'Nothing to see here' }, body: '\nThis is some text about some stuff that happened sometime ago', frontmatter: 'title: Just hack\'n\ndescription: Nothing to see here' }
front matter虽然格式看起来不太统一,却是对markdown强有力的补充。