<h2>Markdown+Pandoc 最佳写作拍档</h2>
<h3>我们为什么写作?</h3>

自从人们开始写作,写作便是记录、抒发、批判、反省的好工具。从石板上的刻印到笔墨纸砚,再到如今的信息时代。从静态的个人主页到托管博客,从个人博客到微博,从wordpress到jekyll。无数投入写作中的人们写作的目的大同,写作的方式越简单越好,这样才能让我们专注于写作而不是为其他格式所困扰。另外现在智能终端快速普及,文件格式的多平台使用也成为了写作的一大问题。

为了更好的写作,今天介绍的 Markdown & Pandoc 便能提供完美的辅助。

Markdown的用法

1 .Markdown是什么?

Markdown 是一种轻量级标记语言,创始人为John Gruber和Aaron Swartz。它允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档”。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。  [1]

2 .为什么要用Markdown?

windows下常用的编辑工具是word,mac上常用的编辑工具是page,linux上常用的编辑工具就是vim了,一份文章编辑完后为了要在不同平台中保存完整的模样时就必需同时准备多种文本格式的文件,这是多么痛苦的一件事。我们写作的初衷是为了写作呀,反而被这些格式烦恼。所以我们要用Markdown,它让你关注内容,格式怎么显示不是要你在写得时候关注的。而在写Markdown时你只需要用一个纯文本的方式进行,不用担心平台与格式的困扰。

3 .Markdown的语法

Markdown 的语法全由一些符号所组成,这些符号经过精挑细选,其作用一目了然。比如:在文字两旁加上星号,看起来就像 强调
。Markdown 的列表看起来,嗯,就是列表。Markdown 的区块引用看起来就真的像是引用一段文字,就像你曾在电子邮件中见过的那样。

最常用格式

<pre class="prettyprint hljs markdown"><code class="text language-text" data-lang="text" data-mce-style="padding: 0px;" style="padding: 0px;"> 空一行(两个回车)分段

行末加两个或多个空格才是真正的换行,否则正常的一个回车就像在 HTML 代码中一样,被当作空格处理

插入链接: [链接文字](url)

图片跟链接很像,在前面加个叹号:![alt 文字](图片 URL)

列表

<pre class="prettyprint hljs markdown"><code class="text language-text" data-lang="text" data-mce-style="padding: 0px;" style="padding: 0px;"><span class="hljs-bullet">* </span>无序(没有编号的)列表中的一项

* 一个子项,要以一个制表符或者4个空格缩进

* 无序列表中的另一个项

1. 有序(排好序,有编号的)列表中的一项

2. 有序列表中的另一个项

标题

<pre class="prettyprint hljs markdown"><code class="text language-text" data-lang="text" data-mce-style="padding: 0px;" style="padding: 0px;"><span class="hljs-section"># 一级标题</span>

#### 四级标题

一级标题

===================

二级标题

--------------------

代码

代码可以采取两种方法:

一是用(`)将代码包起来

<pre class="prettyprint hljs ruby"><code class="text language-text" data-lang="text" data-mce-style="padding: 0px;" style="padding: 0px;">夹杂着<span class="hljs-string">`一些代码`</span>的文字内容,

二是在代码块前面加上4个空格或者一个TAB

<pre class="prettyprint hljs python"><code class="text language-text" data-lang="text" data-mce-style="padding: 0px;" style="padding: 0px;">	<span class="hljs-keyword">import</span> random

<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">CardGame</span><span class="hljs-params">(object)</span>:</span>
<span class="hljs-string">""" a sample python class """</span>
NB_CARDS = <span class="hljs-number">32</span>
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">__init__</span><span class="hljs-params">(self, cards=<span class="hljs-number">5</span>)</span>:</span>
self.cards = random.sample(range(self.NB_CARDS), <span class="hljs-number">5</span>)
<span class="hljs-keyword">print</span> <span class="hljs-string">'ready to play'</span>

代码高亮可以由github提供的js实现

分割线

要生成水平分割线,可以在单独一行里输入3个或以上的短横线、星号或者下划线实现。短横线和星号之间可以输入任意空格。以下每一行都产生一条水平分割线。

<pre class="prettyprint hljs markdown"><code class="text language-text" data-lang="text" data-mce-style="padding: 0px;" style="padding: 0px;">===========

**

_ _ _

Markdown的常用语法差不多就是这些了,详细的介绍请参考 Markdowm 语法说明

4 .Markdown的常用编辑工具

  • Mac等平台下推荐 Mou
  • Windows平台推荐 MarkdownPad
  • Sublime Text
    编辑器是我的最爱,并且它是跨平台的,结合 Markdown preview
    插件能更好的编辑
  • markdown-here
    借助Chrome插件,将gmail、Evernote、Hotmail等写作窗口变为Markdown在线写作窗口
  • web版推荐国人 草依山
    写的 MaHua
    ,支持vim快捷键和多种主题。

Markdown越来越流行,不是因为它复杂,而是因为它足够简单。尝试过MD后就能体会到单纯的写作带来的快乐,一般Markdown文件保存格式都是以md、mdownx现实。为了文档的分享,多平台的使用,需要对MD进行格式转化。这是就更体现了它的方便之处,它是本身是一个结构标记语言,能对多种格式文档进行转换,这里介绍一款强大的格式转换工具  Pandoc
 。

Pandoc 格式转换的瑞士军刀

1 .Pandoc的介绍

Pandoc是一个用于从一种标记格式转换为另一种的Haskell库,它的功能是在多种常见的标记语言进行相互转换。

其中包括 Markdown, reStructuredText, Textilte, HTML, PDF,LaTeX 等。利用它,你可以用简单的 Markdown 语法生成pdf文档,还可以写 Beamer 演示文稿。更强大的是,它还能将以上提到的这些语言所写文件转换成 xdoc 文档。

2 .Pandoc的用法

2.1 Web版Pandoc

首先我们可以看下Pandoc的官网  http://johnmacfarlane.net/pandoc/

在介绍中我们知道Pandoc支持linux,Mac OS,Win多平台,还有简易的web版提供我们在线转换格式。打开web版  http://johnmacfarlane.net/pandoc/try
,便可以进行简单的格式转换了。不过网页版的反应速度不是很快,不适合大型文件的格式转换,一两篇文章还是可以的。

2.2 Linux版Pandoc

就我自己用的ubuntu下安装Pandoc,还算是非常简单的。以下是ubuntu下的使用步骤:

<pre class="prettyprint hljs nginx"><code class="text language-text" data-lang="text" data-mce-style="padding: 0px;" style="padding: 0px;"><span class="hljs-attribute">sudo</span> apt-get install pandoc

如果apt-get安装的pandoc功能不齐全,可以如官网上一样先安装cable,再安装pandoc:

<pre class="prettyprint hljs sql"><code class="text language-text" data-lang="text" data-mce-style="padding: 0px;" style="padding: 0px;">sudo apt-get <span class="hljs-keyword">install</span> cabal-<span class="hljs-keyword">install</span>

cabal update

cabal install pandoc

然后就可以尝试着用一下了:

<pre class="prettyprint hljs css"><code class="text language-text" data-lang="text" data-mce-style="padding: 0px;" style="padding: 0px;"><span class="hljs-selector-tag">pandoc</span> <span class="hljs-selector-tag">demo</span><span class="hljs-selector-class">.md</span> <span class="hljs-selector-tag">-o</span> <span class="hljs-selector-tag">demo</span><span class="hljs-selector-class">.html</span>

这样便可以简单的将demo的markdown文件转换成html文档了。另外还可以强制格式转换如下:

<pre class="prettyprint hljs css"><code class="text language-text" data-lang="text" data-mce-style="padding: 0px;" style="padding: 0px;"><span class="hljs-selector-tag">pandoc</span> <span class="hljs-selector-tag">demo</span><span class="hljs-selector-class">.txt</span> <span class="hljs-selector-tag">-o</span> <span class="hljs-selector-tag">demo</span><span class="hljs-selector-class">.html</span> <span class="hljs-selector-tag">-f</span> <span class="hljs-selector-tag">markdown</span> <span class="hljs-selector-tag">-t</span> <span class="hljs-selector-tag">html</span>

上面的代码便是将demo.txt中的文档以markdown的格式转换成html并存入demo.html中了。

最关键的  PDF文件
 到了,PDF文档能在不同平台保持一致的表现,是许多文档传输的首选。在转换PDF之前,还需要安装一个texlive的包:

<pre class="prettyprint hljs nginx"><code class="text language-text" data-lang="text" data-mce-style="padding: 0px;" style="padding: 0px;"> <span class="hljs-attribute">sodu</span> apt-get install texlive

然后便可以自如的转换PDF文件了:

<pre class="prettyprint hljs css"><code class="text language-text" data-lang="text" data-mce-style="padding: 0px;" style="padding: 0px;"><span class="hljs-selector-tag">pandoc</span> <span class="hljs-selector-tag">demo</span><span class="hljs-selector-class">.md</span> <span class="hljs-selector-tag">-o</span> <span class="hljs-selector-tag">demo</span><span class="hljs-selector-class">.pdf</span>

英文文件转换状况良好,中文字体问题请参考 Pandoc 用命令行转换标记语言

Markdown与Pandoc的用法也就说到这了,无疑它们搭配起来会让写作变得更加简单专注,这也就是我们的初衷。另外在写作中多结合Git,将文档推到GitHub上会是很好的尝试。

参考文档

Markdown+Pandoc 最佳写作拍档 (mailp.in)的更多相关文章

  1. Wiz写Blog? 不会再爱了,全面拥抱Markdown+Pandoc

    Wiz写Blog? 不会再爱了,全面拥抱Markdown+Pandoc 文章转载自 http://iout.in/archives/454.html 我们为什么写作? 自从人们开始写作,写作便是记录. ...

  2. 使用Markdown+Pandoc+LaTex+Beamer制作幻灯片

    概述 为什么使用markdown? mardown是一种轻量级的标记语言,语法简单,可读性好,并且容易转化成其他格式的文档, 在技术文档撰写中得到越来越广泛的应用.相信大家对markdown都有一定了 ...

  3. 用MarkDown来排版写作

    Latex排版系统太复杂,MD很好用,微软开源了一套Madoko的开源在线MD编辑器,它提供了一台MD扩展,可以生成PDF(中间先生成Tex,再生成的PDF),幻灯片还有html.非常方便.写作,写p ...

  4. Markdown写作

    What is markdown? Markdown 是一种轻量级的「标记语言」,它的优点很多,目前也被越来越多的写作爱好者,撰稿者广泛使用.看到这里请不要被「标记」.「语言」所迷惑,Markdown ...

  5. [置顶] 献给写作者的 Markdown 新手指南

    作者:http://jianshu.io/p/q81RER 出处:http://jianshu.io/p/q81RER 献给写作者的 Markdown 新手指南 简书 「简书」作为一款「写作软件」在诞 ...

  6. 【转载】Markdown使用笔记

    献给写作者的 Markdown 新手指南 http://www.jianshu.com/p/q81RER 「简书」作为一款「写作软件」在诞生之初就支持了 Markdown,Markdown 是一种「电 ...

  7. 文件转换神器Pandoc使用

    最近记录笔记,改用Markdown格式.但有时需要分享下笔记,对于不懂markdown格式的同学来说阅读感觉不是那么友好.因此就一直在寻找一款文件转换的软件,之前因为用markdownpad来编写,可 ...

  8. 献给写作者的 Markdown 新手指南

    「简书」作为一款「写作软件」在诞生之初就支持了 Markdown,Markdown 是一种「电子邮件」风格的「标记语言」,我们强烈推荐所有写作者学习和掌握该语言.为什么?可以参考: 『为什么作家应该用 ...

  9. Markdown语法 中文版

    文章翻译自Markdown创始人JOHN GRUBER的 个人博客, 英文原文请参见 Markdown Syntax; 本文地址: http://www.cnblogs.com/ayning/p/43 ...

随机推荐

  1. 我的学习之路_第二十九章_bootstrap

    bootstrap 内置了html,css,js插件为一体的前端框架 响应式布局: 设计一套页面就可以使用于很多现实设备 bootstrap: 1.入门(响应式布局的容器) 1.先进入jQuery的j ...

  2. AppDomain 及BuildManager

    一.AppDomain.CurrentDomain.DynamicDirectory 只有在Web项目中在值,动态执行目录像下面这样 Framework\v4.0.30319\Temporary AS ...

  3. Spark 2.2.0 文档中文版 Quick Start

    原地址:http://spark.apache.org/docs/latest/quick-start.html 这篇指导对使用Spark提供了一个快速的介绍.我们首先介绍API,通过spark交互式 ...

  4. win10 运行sqlplus报错“SP2-1503: 无法初始化 Oracle 调用界面”

    解决方法: 1.临时方案:此时可以以“管理员身份”运行cmd,然后再执行sqlplus就行了. 长久方案: 请看原文:http://blog.csdn.net/bisal/article/detail ...

  5. 一步一步学习Vue(六)

    本篇继续介绍vue-router,我们需要要完成这样个demo:<分页显示文章列表>:这里我们以博客园首页列表为例简化处理: 按照上图框选所示,简单分为蓝色部分文章组件(ArticleIt ...

  6. (转)示例化讲解RIP路由更新机制

      目录(?)[+]   以下内容摘自最新上市的“四大金刚”图书之一<Cisco路由器配置与管理完全手册>(第二版)(其它三本分别为<Cisco交换机配置与管理完全手册>(第二 ...

  7. Hbase单机安装部署

    Hbase单机安装部署 http://blogxinxiucan.sh1.newtouch.com/2017/07/27/Hbase单机安装部署/ 下载Hbase Hbase官网下载地址 http:/ ...

  8. Node.js 入门:Express + Mongoose 基础使用

    前言 Express 是基于 Node.js 平台的 web 应用开发框架,在学习了 Node.js 的基础知识后,可以使用 Express 框架来搭建一个 web 应用,实现对数据库的增删查改. 数 ...

  9. c++文件编译的一些说明

    1,头文件只在于预处理阶段用于完全包含该头文件的内容,每个c文件是一个编译单元,类定义和类声明,变量和函数声明,类内联实现是内部链接,全局变量和函数的定义以及类外部实现是具有全局链接性,假设将所有c单 ...

  10. react学习01

    react react render()函数返回只能是一个标签(里面可以包其他东西) state(状态) vs props(属性) state 改变,视图改变,state是一个组件里面的状态,然后pr ...