markdown是
非常简单方便的一个文本标记语言,基本上几分钟就能掌握。它使用文本和少量格式转义符,通过结合前端技术自动生成最终HTML文本,使用markdown可以让人在文档编写过程中专注于内容而不是格式调整,从而提高了写作的效率。

Markdown is a lightweight markup language with plain text formatting syntax. It is 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 text files, for writing messages in online discussion forums, and to create rich text using a plain text editor.

  • # 代表一级标题,##二级标题,以此类推,######六级标题,对应HTML的<h1>~<h6>标签;
  • - 代表无序列表,对应HTML的<ul>;
  • 1. 代表有序列表,对应HTML的<ol>;
  • > 引用,如下图显示,对应HTML的<blockquote>;
  • *text* or _text_ 斜体,代表HTML<i>;
  • **text** or __text__ 加粗,代表HTML<b>;
  • ![text](URL) 图片标签。考虑到图片需要转义显示,牵扯到目录和网络显示,markdown添加图片最好配合插件工具进行;
  • [link](URL) 链接标签;
  • 如果想显示一行代码,使用`(数字1左边那个按键)包含即可,对应HTML的code标签,用于inline显示代码或不想被markdown转义的内容;
  • 如果想显示一段代码,如下显示:
1
2
3
4
5
var http = require('http');
http.createServer(function(req,res){
res.writeHead(200, {'Content-Type':'text/html'});
res.end('hello,markdown!');
}).listen(8080);
也就是对应HTML里的`<pre>`标签,有两种写法: 1. 每行代码前空4个空格; 2. 上下行添加```即可;

还有几个书写的基本规范,凡是单个的标记,记得在后面加上一个空格,例如#-等等;段落标签<p>,回车空行即可;段内换行,在行末添加两个空格;

  • 表格的显示有简单方法和扩展方法,建议使用vscode或其他编辑器的扩展功能编写表格,如下是用Markdown Table Generator生成的一个表格;

    |       |       |       |
    |  ---  |  ---  |  ---  |
    |       |       |       |
    |       |       |       |
    |       |       |       |
    

掌握以上这些基本命令,一般的文章的书写基本上就没有什么问题了。目前有好多笔记类软件都对Markdown进行了扩展,让其支持更多的内容格式,比如待办事项、UML流程图以及公式等等,还有些提供了网络服务,有兴趣的可以自行了解;