Markdown吃了吗?

markdown 介绍

Markdown 是一种轻量级标记语言,它允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档”。 - wikipedia

why markdown

目前很多在线服务商均支持使用markdown编写:

  • Github 最先支持,使用Markdown的一个分支版本来格式化评论、消息以及其它内容。
  • Stack Overflow 使用一种 Markdown 的分支作为它的文章格式化系统。
  • 博客园 国内技术人的博客家园,每天活跃上万用户,高质量社区。
  • CSDN 号称全球最大中文IT社区,涵盖了多种语言、架构、博客、俱乐部等模块的技术论坛。
  • 图灵社区 使用markdown语法供用户写作电子书.
  • 简书 重拾文字的力量,交流故事,沟通想法,一个基于内容分享的社区。
  • 为知笔记 国内顶尖笔记软件,支持使用Markdown语法编辑笔记。
  • 有道云笔记 最新版本开始支持,并且支持一些扩展语法。
  • ……

markdown 使用

markdown 工具

  • 马克飞象 web/chrome 离线客户端,markdown 全功能支持,最大特点内容能够同步到印象笔记(evernote)中,笔记的用户重度推荐,按年收费,目前作者 @weibo 正在开发跨平台的客户端。
  • StackEdit 在线 markdown 编辑器,可同步文档到Google Drive和 Dropbox,可发布文章到 Blogger,GitHub,Google Drive,Dropbox,Tumblr和WordPress。
  • cmd 作业部落 支持 win/mac/linux/web/chrome 全平台,支持实时同步预览,支持代码高亮、数学公式,区分写作和阅读模式,支持在线存储,分享文稿网址。
  • MacDown OSX 上的 Markdown 开源编辑器,支持代码高亮,实时预览等。
  • MarkdownPad Windows上的全功能Markdown编辑器,推荐win上使用,基本全部功能。
  • Marked2 多种 md 显示方案,不能够编辑文件,只用来展示文件,配合 subline text markdown edit 插件,完美使用;
  • MWeb 专业的 Markdown 写作、记笔记、静态博客生成软件,由国内独立开发者@oulvhai开发,支持Toc、Table、代码高亮、支持发布到 Wordrpess 博客、支持 Metaweblog API 的博客服务、Wordpress.com、Evernote 和印象笔记、Blogger、Scriptogr.am、Tumblr等服务。
  • Haroopad 又一款简洁多功能的跨平台编辑器,全功能支持,再加上对社交网络友好的连接,多种主题等,感兴趣的可以看看。详情参考issue#1
  • Typora 不分栏,实时展示看到写出的内容,对于不喜欢「两栏」设计的人来说是一个选择
  • MarkEditor - ME MarkEditor以markdown为基础语法,多标签栏、文件夹结构,纯文本的方式带来优雅、高效的体验。 确实很棒的工具,带来很多新鲜的理念,支持、重构、提升 markdown,加快写作的体验。具体可以查看几篇评测文章:
  • 码字必备:18 款优秀的 Markdown 写作工具 | 2015 年度盘点 喜欢哪一款,就看你的了。
  • 这几款就够了,多了就有选择症 ……

markdown流程图

1.1 流程图

1.1 横向流程图源码格式:

graph LR
A[方形] --> B(圆角)
    B --> C{条件a}
    C --> |a=1| D[结果1]
    C --> |a=2| E[结果2]
    F[横向流程图]

1.2 竖向流程图源码格式:

graph TD
A[方形] --> B(圆角)
    B --> C{条件a}
    C --> |a=1| D[结果1]
    C --> |a=2| E[结果2]
    F[竖向流程图]

1.3 标准流程图源码格式:

1.4 标准流程图源码格式(横向):

1.2 UML时序图

1.2.1 UML时序图源码样例:

1.2.2 UML时序图源码复杂样例:

1.2.3 UML标准时序图样例:

%%时序图例子, -> 实线, --> 虚线, ->> 实线箭头
    sequenceDiagram
        participant 张三
        participant 李四
        张三 -> 王五: 王五你好吗?
        loop 健康检查
            王五 -> 王五: 与疾病战斗
        end
        Note right of 王五: 合理饮食 
看医生... 李四 ->> 张三: 很好! 王五 -> 李四: 你怎么样? 李四 --> 王五: 很好!

1.3 甘特图样例:

%%语法示例
    gantt
    dateFormat YYYY-MM-DD
    title 软件开发甘特图

    section 设计
    需求  :done, des1, 2014-01-06, 2014-01-08
    原型  :active, des2, 2014-01-09, 3d
    UI设计    :des3, after des2, 5d
    未来任务:   :des4, after des3, 5d

    section 开发
    学习准备理解需求    :crit, done, 2014-01-06, 24h
    设计框架    :crit, done, after des2, 2d
    开发  :crit, active, 3d
    未来任务    :crit, 5d
    耍   :2d

    section 测试
    功能测试    :active, a1, after des3, 3d
    压力测试    :after a1, 20h
    测试报告    :48h

数学公式

矩阵方程

$$
\begin{matrix}
1 & x & x^2 \
1 & y & y^2 \
1 & z & z^2 \
\end{matrix}
$$

reference 参考

  • Why Markdown? A two-minute explanation
  • 简书:献给写作者的 Markdown 新手指南
  • Markdown simple world
  • MathJax语法规则
  • Mermaid语法规则
  • Mermaid官方教程
  • Mermaid Github仓库
  • [MathJax Github仓库](https://github.com/mathjax/MathJax