markdown

Posted on   |   In   |     |   Views

markdown 轻量级标记语言（html、xml），它允许人们“使用易读易写的纯文本格式编写文档”，Markdown 最重要的设计就是可读性，Markdown 可以选择性的转换为 HTML 文档格式，很多网站目前都使用了 Markdown 或者其变种，例如Github、简书等大型社区。

markdown 特点

  • 纯文本，所以兼容性极强，可以用所有文本编辑器打开
  • 专注于文字写作而不是排版
  • 格式转换方便，可以轻松转换为 HTML、PPT、电子书等
  • Markdown 标记语法简单好记，可读性强

实时预览编辑器

月光博客 - 好用的Markdown编辑器一览

  • dillinger
  • 马克飞象
  • 简书
  • MarkdownPad
  • Sublime Text
    • 配合 Markdown Preview 插件
  • Webstorm
    • 配合插件
  • gitbook

编辑实时预览工具只是为了辅助教学而已，我们真正在进行写作的时候，其实是不需要实时预览的，因为 Markdown 标记语言本身已经足够清晰了。

Markdown 基本语法

注意：每个标题、段落、图片、代码段、一个列表之间都用一行空行分开；

  • 标题
    • #: 表示 h1,
    • ## 表示 h2,
    • ###: 表示 h3,
    • #### 表示 h4,
    • #####: 表示 h5,
    • ##### 表示 h6
  • 段落
    • 直接写，不用任何空格
  • 粗体 粗体用一对 ``包裹**
  • 斜体 斜体用一对``包裹*
  • 无序列表
    • 一级用 - 加一个空格
    • 二级用 一个 tab 之后加一个 + 和一个空格
    • 三级同样再放一个 tab 之后加一个 * 和一个空格
  • 有序列表
    • 数字. 加空格
  • 链接
    • [连接名称](连接url)
  • 图片
    • ![图片名称](图片路径url)
  • 文本引用
    • 用一个 > 来引用
  • 行内代码引用
    • 一对反引号包裹，esc 下面的键
  • 多行代码引用
    • 一对三个反引号包裹
  • 表格

表格比较特殊，不太好用，下面是规范写法：

1
2
3
4
5
| ABCD | EFGH | IJKL |
| -----|:----:| ----:|
| a    | b    | c    |
| d    | e    |  f   |
| g    | h    |   i  |

Markdown 使用场景

  • 学习笔记
    • 手写笔记
  • 演讲稿
    • 技术沙龙，party
    • Markdown 演讲稿
  • 写书（侧重于技术相关的内容非常适合）
  • 个人笔记
  • 文章博客
  • 教学讲义
  • 说明文档
    • 使用比较多，软件的说明文档或者开源项目的说明文档
  • 电子邮件

只要有写作的地方，都可以使用 Markdown 来书写。

用 Markdown 编辑电子邮件

Markdown 本身语法简单，使用 Markdown 写出来的内容结构也非常清晰，有助于协作沟通，总而言之，使用 Markdown 可以可以更加专注写作本身。

其实就是将 md 格式字符串转换成 html 而已，这里使用一个 Chrome 插件：

Markdown Here

使用 GitBook 制作电子书

GitBook

  • 在线 Web 端写
  • 使用客户端软件写
  • 终端命令行工具可以辅助生成

自己动手做一个 Markdown 实时预览编辑器

Markdown 本身就是一个标记语言，可以通过某种方式转换成别的文本格式，本质上转换的过程其实就是做正则解析替换。

  • 如何将markdown格式字符串转成html
    • 使用一个第三方包：marked
    • npm install marked
  • 给 html 设置样式
  • 给代码块设置颜色高亮

Thanks

感谢您的支持！