DocumentEditor: Markdown

---

Markdown is a lightweight markup language with plain text formatting syntax designed so that it can be converted to HTML and many other formats using a tool by the same name. Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor. –wikipedia

---

0. Document Editor: TXT, Markdown, Word

当我们在使用编辑器编写文档的时候，
于主体（我们）而言，我们希望编辑器提供的操作尽可能简易，以达到主体高效的目的；
于客体（文档）而言，我们希望编辑器提供的格式尽可能多样，以达到客体美观的目的。
从而，我们所考虑的两个最重要的因素是它的操作简易度与格式多样度即希望拥有这样的编辑器：它既可以提供简易的操作，又可以提供多样的格式。
然而，简易的操作往往等价于简单的格式，多样的格式往往等价于复杂的操作，二者不可兼得。
因此，我们就在操作简易度与格式多样度间找到一个折中点：操作较简单，格式较多样——Markdown
是谓：中庸之道。

编辑器 操作简易度 格式多样度 TXT 简易 稀少 Markdown 中等 中等 Word 复杂 多样

---

1. 用途

与其中等的操作简易度与格式多样度相对应，Markdown用于编写操作较为简便与格式较为多样的文档：

文档 文档说明 CSDN BLOG 经验之谈与微型项目 Github README 小型项目与中型项目 项目简易文档报告 课程实验等微小型项目

---

2. 使用

编辑:

记事本，调整字体格式为新宋体5号

显示：

CSDN-markdown编辑器，亦可浏览器输入http://write.blog.csdn.net/mdeditor，在线离线皆可

Stackedit编辑器，亦可浏览器输入https://stackedit.io/editor#，在线离线皆可

Github-markdown编辑器

Chrome Markdown Preview Plus

转换：

HTML-with-style文件: 本地markdown文件 -> CSDN-markdown编辑器 -> HTML-with-style文件

PDF文件: 本地markdown文件 -> CSDN-markdown编辑器 -> HTML-with-style文件 -> Chrome浏览器打印 -> PDF文件

PDF文件：Chrome浏览器（Mardown Preview Plus）打印 -> PDF文件

---

3. Markdown Editor

考察Markdown集成编辑器的优劣，主要是看其在编辑与转换两个方面的性能：

• 在编辑方面，几乎所有的编辑器都提供即时显示的功能。然而，个人更偏向于新宋体5号的字体，且由于Markdown语法较为简单，即时显示功能的重要性并不较突出，因此，更偏向于记事本纯文本文档编辑器。
• 在转换(to HTML, or HTML with style)方面，由于Markdown与HTML文件的语法及格式高度一致性，因此对于从Markdown到HTML的转换较为简单，转换后的格式也相差无几。
• 在转换(to PDF)方面，由于Markdown转换成PDF的过程中歧义性较大，二者在格式上相差太大，因此尽如人意的转换是相当难以实现的，从而我们只能从有限的几个方面来评价转换的性能，主要是分页与图片在换页中不会被切割两个方面等。也正因为如此，性能相对较好的转换也大都是收费的。
  
  • 直接转换：性能相对较好的转换也大都是收费的
  • Pandoc转换（Pandoc+MiKTex）：交互不友好，而且一直报错
  • www.markdowntopdf.com在线转换：一直没成功
  • 通过HTML到Chrome Print转换：当前最优的转换方式
    
    

软件 Editor HTML Convertor PDF Convertor CmdMarkdown - - 收费 Haroopad - - 不支持 MarkdownPad2 - - 收费(注册码),不分页 MdCharm - - 收费

---

4. Markdown Syntax

欢迎使用Markdown编辑器写博客

本Markdown编辑器使用StackEdit修改而来，用它写博客，将会带来全新的体验哦：

• Markdown和扩展Markdown简洁的语法
• 代码块高亮
• 图片链接和图片上传
• LaTex数学公式
• UML序列图和流程图
• 离线写博客
• 导入导出Markdown文件
• 丰富的快捷键

---

快捷键

• 加粗 Ctrl + B
• 斜体 Ctrl + I
• 引用 Ctrl + Q
• 插入链接 Ctrl + L
• 插入代码 Ctrl + K
• 插入图片 Ctrl + G
• 提升标题 Ctrl + H
• 有序列表 Ctrl + O
• 无序列表 Ctrl + U
• 横线 Ctrl + R
• 撤销 Ctrl + Z
• 重做 Ctrl + Y

Markdown及扩展

Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档，然后转换成格式丰富的HTML页面。 —— [ 维基百科 ]

使用简单的符号标识不同的标题，将某些文字标记为粗体或者斜体，创建一个链接等，详细语法参考帮助？。

本编辑器支持 Markdown Extra , 　扩展了很多好用的功能。具体请参考Github.

表格

Markdown　Extra　表格语法：

项目 价格 Computer $1600 Phone $12 Pipe $1

可以使用冒号来定义对齐方式：

项目 价格 数量 Computer 1600 元 5 Phone 12 元 12 Pipe 1 元 234

定义列表

Markdown　Extra　定义列表语法：

项目１

项目２

定义 A

定义 B

项目３

定义 C

定义 D

定义D内容

代码块

代码块语法遵循标准markdown代码，例如：

@requires_authorizationdef somefunc(param1='', param2=0):    '''A docstring'''    if param1 > param2: # interesting        print 'Greater'    return (param2 - param1 + 1) or Noneclass SomeClass:    pass>>> message = '''interpreter... prompt'''

脚注

生成一个脚注1.

目录

用 [TOC]来生成目录：

数学公式

使用MathJax渲染LaTex 数学公式，详见math.stackexchange.com.

• 行内公式，数学公式为：Γ(n)=(n−1)!∀n∈N。
• 块级公式：

x=−b±b2−4ac−−−−−−−√2a

更多LaTex语法请参考 这儿.

UML 图:

可以渲染序列图：

或者流程图：

• 关于 序列图 语法，参考 这儿,
• 关于 流程图 语法，参考 这儿.

离线写博客

即使用户在没有网络的情况下，也可以通过本编辑器离线写博客（直接在曾经使用过的浏览器中输入write.blog.csdn.net/mdeditor即可。Markdown编辑器使用浏览器离线存储将内容保存在本地。

用户写博客的过程中，内容实时保存在浏览器缓存中，在用户关闭浏览器或者其它异常情况下，内容不会丢失。用户再次打开浏览器时，会显示上次用户正在编辑的没有发表的内容。

博客发表后，本地缓存将被删除。　

用户可以选择 把正在写的博客保存到服务器草稿箱，即使换浏览器或者清除缓存，内容也不会丢失。

注意：虽然浏览器存储大部分时候都比较可靠，但为了您的数据安全，在联网后，请务必及时发表或者保存到服务器草稿箱。

浏览器兼容

1. 目前，本编辑器对Chrome浏览器支持最为完整。建议大家使用较新版本的Chrome。
2. IE９以下不支持
3. IE９，１０，１１存在以下问题
   
   1. 不支持离线功能
   2. IE9不支持文件导入导出
   3. IE10不支持拖拽文件导入

---

---

---

1. 这里是 脚注 的 内容. ↩