玩转markdown 分享几个需要用到的工具

【引自ideras.me的博客】前言

随着wordpress和静态网站的流行,markdown被用的越来越多。

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

markdown解析器

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

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

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

marked

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

CLI调用代码示例

$ marked -o hello.html
hello world
^D
$ cat hello.html
<p>hello world</p>

API调用示例

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

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

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

marked.setOptions({
 highlight: function (code, lang) {
 var res;
 if (lang) {
  res = hljs.highlight(lang, code, true).value;
 } else {
  res = hljs.highlightAuto(code).value;
 }
 return res;
 }
}); 

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

markdown-js

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

markdown生成器

to-markdown

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

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

简单的代码示例

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

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强有力的补充。

时间: 2016-08-29

Markdown语法备忘

Markdown编辑器 Windows:   1. MarkdownPad   2. MarkPad Mac:   *Mou Linux:   * ReText Markdown语法 1.标题 复制代码 代码如下: # H1 <一级标题> ## H2<二级标题> 依次类推,直到 ###### H6<六级标题> 注意:#号和文字之间要有一个空格 2.文字格式 复制代码 代码如下: **文字粗体格式** --->在要加粗的文字左右各加两个*(星号) *文字斜体格式*-

Markdown+Bootstrap图片自适应属性详解

Markdown 是一种轻量级的「标记语言」,它的优点很多,目前也被越来越多的写作爱好者,撰稿者广泛使用.看到这里请不要被「标记」.「语言」所迷惑,Markdown 的语法十分简单.常用的标记符号也不超过十个,这种相对于更为复杂的 HTML 标记语言来说,Markdown 可谓是十分轻量的,学习成本也不需要太多,且一旦熟悉这种语法规则,会有一劳永逸的效果. 使用 Markdown 的优点 1.专注你的文字内容而不是排版样式,安心写作. 2.轻松的导出 HTML.PDF 和本身的 .md 文件.

python 自动化将markdown文件转成html文件的方法

一.背景 我们项目开发人员写的文档都是markdown文件.对于其它组的同学要进行阅读不是很方便.每次编辑完markdown文件,我都是用软件将md文件转成html文件.刚开始转的时候,还没啥,转得次数多了,就觉得不能继续这样下去了.作为一名开发人员,还是让机器去做这些琐碎的事情吧.故写了两个脚本将md文件转成html文件,并将其放置在web服务器下,方便其他人员阅读. 主要有两个脚本和一个定时任务: •一个python脚本,主要将md文件转成html文件: •一个shell脚本,主要用于管理逻

markdown简介和语法介绍

一.前言 之前有了解过markdown,但一直没实际使用,今天试用了下,感觉很爽,推荐给大家,特别是在编写规范.接口文档等方面非常适合,因为其简单易用也有很多人用来写网络小说. 二.介绍 Markdown 的目标是实现易读易写,可以直接在问编辑器书写和保存,除本身具有非常好的可读写外,还可以生存格式非常好看的html代码发布在互联网中. 如链接:我们,其书写格式为: [我们](http://www.jb51.net/) Markdown 不是想要取代 HTML,甚至也没有要和它相近,它的语法种类

Markdown与Bootstrap相结合实现图片自适应属性

先给大家说下Markdown的基本概念及优点 Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式. Markdown 是一种轻量级的标记语言,它的优点很多,目前也被越来越多的写作爱好者,撰稿者广泛使用.看到这里请不要被标记.语言所迷惑,Markdown 的语法十分简单.常用的标记符号也不超过十个,这种相对于更为复杂的 HTML 标记语言来说,Markdown 可谓是十分轻量的,学习成本也不需要太多,且一旦熟悉这种语法规则,会有一劳永

在Ruby on Rails中使用Markdown的方法

实现 Markdown 语法和代码语法高亮分别是用的 Redcarpet 和 pygments.rb 两个 Gem: https://github.com/vmg/redcarpet     https://github.com/tmm1/pygments.rb     https://github.com/richleland/pygments-css     http://pygments.org/docs/lexers/ 在/Gemfile中添加如下两行: gem 'redcarpet'

使用Python来开发Markdown脚本扩展的实例分享

关于Markdown 在刚才的导语里提到,Markdown 是一种用来写作的轻量级「标记语言」,它用简洁的语法代替排版,而不像一般我们用的字处理软件 Word 或 Pages 有大量的排版.字体设置.它使我们专心于码字,用「标记」语法,来代替常见的排版格式.例如此文从内容到格式,甚至插图,键盘就可以通通搞定了.目前来看,支持 Markdown 语法的编辑器有很多,包括很多网站(例如简书)也支持了 Markdown 的文字录入.Markdown 从写作到完成,导出格式随心所欲,你可以导出 HTML

可能是最通俗的一篇介绍markdown的文章

这些日子一直在简书上使用markdown写作,已经渐渐的痴迷于这种简洁纯粹的写作方式了.不过就我逐渐入门markdown的写作过程来看,目前我看到的各种介绍markdown写作方式的文章都还略显"极客",对于大多数像我一样没有基础的普通人来说,可能内容上的可接受性没有那么强. 于是诞生了写这篇文章的初衷,让更多普通的人理解并爱上这种写作方式.所以全文应该不会出现什么生僻的词汇,大家可以放心的看下去.(好吧其实原因是那些生僻词汇我也不懂啊哈哈) markdown是什么? markdown

如何使用Gitblog和Markdown建自己的博客

下面给大家分享下如何使用Gitblog和Markdown建自己的博客,如何大家拥有服务器或者云平台提供的云主机,我推荐大家使用Linux+ Nginx 来运行Gitblog,如果大家目前只有Apache环境也可以. 域名解析 将你准备好的域名解析到你的主机IP,推荐使用 dnspod 来管理和监控你的域名,具体的使用方法参考dnspod官方说明文档,非常简单. Nginx+PHP运行环境 首先安装好你的Nginx和PHP环境,PHP版本要求5.3以上.如果你没有安装过,可Google搜索相关教程

献给写作者的 Markdown 新手指南

作为一款「写作软件」在诞生之初就支持了 Markdown,Markdown 是一种「电子邮件」风格的「标记语言」,我们强烈推荐所有写作者学习和掌握该语言.为什么?可以参考: 『为什么作家应该用 Markdown 保存自己的文稿』. 『Markdown写作浅谈』 在此,我们总结 Markdown 的优点如下: 纯文本,所以兼容性极强,可以用所有文本编辑器打开. 让你专注于文字而不是排版. 格式转换方便,Markdown 的文本你可以轻松转换为 html.电子书等. Markdown 的标记语法有极

js验证手机号码

闲来没事,写了一个小例子,欢迎大家多提宝贵建议~~~ 下面讲一下手机号码的特征:以1开头,第二位是3,5,7,8,9中的一位,从第三位开始是任意数字,一共有11位 <!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>手机号码验证</title> </head> <body> Tel:<input type="

js代码验证手机号码和电话号码是否合法

这篇文章主要介绍了js代码验证手机号码和电话号码是否合法,手机号码和电话号码在某些网站都是必填项,为了提高用户体验度,一般要进行合法性校验的,具体代码如下:function Checkreg(){ ..... function Checkreg(){ //验证电话号码手机号码,包含 , 号段 if(document.form.phone.value==""&&document.form.UserMobile.value==""){ alert(&qu

js验证电话号码手机号码的正则表达式

下面提供的几款关于js 验证电话号码手机号码正则表达式,是我从网上收藏了,不过都是精品,专业针对手机号与电话号码进行验证的. 复制代码 代码如下: function checkPhone(phone) { //验证电话号码手机号码,包含153,159号段 if (phone==""){ alert("电话号码不能为空!"); return false; } if (phone != ""){ var p1 = /^(([0+]d{2,3}-)?(

非常实用的js验证框架实现源码 附原理方法

本文为大家分享一个很实用的js验证框架实现源码,供大家参考,具体内容如下 关键方法和原理: function check(thisInput) 方法中的 if (!eval(scriptCode)) { return false; } 调用示例: 复制代码 代码如下: <input type="text" class="text_field percentCheck" name="progress_payment_two" id="

js验证表单大全

不错的JS验证~~~~~~~~~~~~~~~~~~~~~~~~~ 用途:校验ip地址的格式 输入:strIP:ip地址 返回:如果通过验证返回true,否则返回false: */ function isIP(strIP) { if (isNull(strIP)) return false; var re=/^(\d+)\.(\d+)\.(\d+)\.(\d+)$/g //匹配IP地址的正则表达式 if(re.test(strIP)) { if( RegExp.$1 <256 && R

JS验证字符串功能

js 验证字符串功能实例代码如下所示: //去除空格 function jsTrim(value) { var reg = /^\S$/; if (!value) return ""; if (value.length == 0) return value; else { var lp, rp; lp = 0; rp = value.length - 1; while ((value.charAt(lp) == " " || (value.charCodeAt(lp

常用的JS验证和函数汇总

下面是我常用一些JS验证和函数,有一些验证我直接写到了对象的属性里面了,可以直接通过对象.方法来调用 复制代码 代码如下: //浮点数除法运算 function fdiv(a, b, n) {     if (n == undefined) { n = 2; }     var t1 = 0, t2 = 0, r1, r2;     try { t1 = a.toString().split(".")[1].length } catch (e) { }     try { t2 = b

28个JS验证函数收集

JS验证函数的调用方法和注意: 1.给表单设置onsubmit="return test()",配合<input type="submit" name="Submit" value="check"> 进行提交. 2.<input type=text onkeydown="test();"> //当鼠标按下直接调用函数验证 3.<input type=text onblur=&q

js验证框架实现代码分享

本文实例为大家分享了js验证框架,很实用,供大家参考,具体内容如下 1.关键方法和原理: function check(thisInput) 方法中的 if (!eval(scriptCode)) { return false; } 2.调用示例: 复制代码 代码如下: <input type="text" class="text_field percentCheck" name="progress_payment_two" id=&quo

js验证手机号、密码、短信验证码代码工具类

本文实例为大家分享了js验证手机号.密码.短信验证码的代码工具类,供大家参考,具体内容如下 代码工具类 /** * 参数较验 * * */ var verification = { stop : false, //倒计时 //验证手机号 phone : function (tel, id) { if ("" == tel || !tel) { mui.toast('手机号不可以为空!'); } else { var reg = /^0?1[3|4|5|7|8][0-9]\d{8}$/;