Markdown 使用教程

Posted wushuaishuai

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Markdown 使用教程相关的知识,希望对你有一定的参考价值。

前言

  以前经常在 github 中看到 .md 格式的文件,一直没有注意,也不明白为什么文本文档的后缀不是 .txt ,后来无意中看到了 Markdown,看到了用这个东西写得一些web界面等特别的规整漂亮,顿时不明觉厉。后来自己学习了一下,感觉这个语言确实简洁、美观,现推荐出来供大家学习和玩玩,希望能对你有用。

  本文图文并茂,避免了单纯看语法的枯燥和繁琐,其实,学习一门新东西真的其乐无穷!

简介  

Markdown 是一种用来文本处理的轻量级 「标记语言」,它用简洁的语法代替排版,而无需像Microsoft的Word一样需要花费大量的时间进行排版、字体设置。它使我们专心于码字,用「标记」语法,来代替常见的排版格式。Markdown不止可以处理文本,使得文字更美观,还支持图像、表格等的插入,大大方便了我们的写作。例如此文从内容到格式,甚至插图,一个键盘可以搞定了,无需鼠标!

  目前来看,支持 Markdown 语法的编辑器有很多,包括很多网站(例如简书)也支持了 Markdown 的文字录入。Markdown 从写作到完成,导出格式随心所欲,你可以导出 html 格式的文件用来网站发布,也可以十分方便的导出 PDF 格式,甚至可以利用 CloudApp 这种云服务工具直接上传至网页用来分享你的文章,全球最大的轻博客平台 Tumblr,也支持 Mou 这类 Markdown 工具的直接上传。

  目前,我们的 博客园 同样支持了Markdown文本的编辑,具体如何设置请往下看!

Markdown特点

  • 专注你的文字内容而不是排版样式;
  • 轻松的导出 HTML、PDF 和本身的 .md 文件;
  • 纯文本内容,兼容所有的文本编辑器与字处理软件;
  • 可读,直观。适合所有人的写作语言。

教程

简明教程:

详细教程

博客园配置Markdown编辑器

  1. 进入博客后台
  2. 点击“设置默认编辑器”
  3. 选中 Markdown并保存
  4. 回到随笔界面点击“添加随笔”
  5. 在“Markdown编辑器”中输入相应的代码
    技术分享图片
    技术分享图片

语法

1. 标题

标题通过 # 的个数来进行区分,Mardown总共支持6级标题。
技术分享图片

2. 段落 & 换行

2.1. 首行缩进/空格:

  •  : 英文空格(半角)
  •  : 中文空格(全角)
  • 输入法切换至全角,双击 空格 「推荐」
  • 半方大的空白  &#8194
  • 全方大的空白 &#8195
  • 不断行的空白格  &#160

2.2. 强制换行

  连续的字符串,如果你想要换行,往往打“Enter”是不管用的,正确的换行方法为在 「在需要换行的地方插入 >=2 个 空格」

2.3. 空行

两种方式:

  • 在markdown中加入 >=2 个空行.
  • 使用<br> 【推荐】
      
    技术分享图片

3. 列表

在Markdown下,有四种列表:有序和无序;

  • 有序列表:采用 1. 2. 3.的形式
  • 无序列表:采用前面加 * - + 的方式,支持多级嵌套
  • 未完成列表:- [ ],每个符号间均有空格
  • 已完成列表:- [x],注意空格使用
    PS: 符号与文字之间必须有 空格

技术分享图片
技术分享图片

4. 引用 (Quote)

若需要引入有出处的一段话等,可以采用引用的方式实现,实现方式为在行开始处加入>,如下所示:
技术分享图片

5. 字体设置

  • 粗体
    字符串前后均加上 **
  • 斜体
    字符串前后均加上 *
  • 删除线
    字符串前后各加 ~~
  • ++下划线++
    字符串前后各加 ++
  • == 字体背景色 ==
    字符串前后各加 ==
  • 标记
    字体前后加上 ` (Esc下方的那个键)

技术分享图片

6. 分割带

当上下文不属于同一模块或者无甚关联时刻,可以使用分隔符进行隔开;分隔符的格式如下:

  • 连续多个-(>=3)
  • 连续多个*(>=3)
  • 连续多个下划线 _ (>=3)
  • PS:以上,分隔符中间可以有空格,但分割行不可有其它字符存在

技术分享图片

7. 图片和链接

  • 图片
    ![]() : [图片名称] (图片网络地址)
  • 链接
    []() : [链接名称(可自定义)] (链接地址)

技术分享图片

8. 代码块

和程序相关的写作或是标签语言原始码通常会有已经排版好的代码区块,通常这些区块我们并不希望它以一般段落文件的方式去排版,而是照原来的样子显示,Markdown 会用制表符来将代码包起来。
代码块一直持续到没有缩进的那一行(或是文件的结尾)

    #include <iostrem>  
    using namespace std;  
    int main(int argc, char **argv)  
    {
        cout << "hello,world!";
    }

技术分享图片

9. 网址自动转换

Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱,只要是<>包起来, Markdown 就会自动把它转成链接。一般网址的链接文字就和链接地址一样,例如:

这个是我的博客地址:https://home.cnblogs.com/u/Jimmy1988/
我的邮箱地址是:[email protected]

技术分享图片

10. 转义

Markdown 可以利用反斜杠来插入一些在语法中有其它意义的符号,例如:如果你想要用星号加在文字旁边的方式来做出强调效果,你可以在星号的前面加上反斜杠:

*literal asterisks*

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

反斜线
` 反引号
* 星号
_ 下划线
{} 花括号
[] 方括号
() 括弧
# 井字号
+ 加号
- 减号
. 英文句点
! 感叹号

11. 生成目录

  • 前提条件:

    标题的建立是采用MD格式实现的,目录的生成建议放在文本最开始部分(当然也可以嵌入在文中)。

  • 语法

    [TOC],中间不要有空格

  • 注意事项

    目录的生成并不是每个编辑器都支持的,至今我用过的编辑器 有道云笔记是支持的。

技术分享图片

12. 表格

技术分享图片
表格的做法通常为:

header 1 | header 2
--- |---
row 1 col 1 | row 1 col 2
row 2 col 1 | row 2 col 2

可用`<br>进行单元格内换行; 但是暂时不支持合并单元格


工具推荐

windows平台

Linux平台

Mac平台

浏览器插件

在线编辑器

  • 麻花:支持在线编辑,关键支持VIM命令

高级应用

更多工具


技术分享图片

以上是关于Markdown 使用教程的主要内容,如果未能解决你的问题,请参考以下文章

Markdown简明教程

markdown 在WordPress中使用jQuery代码片段

VS Code配置markdown代码片段

VS Code配置markdown代码片段

markdown PHPExcel Notes和代码片段

markdown Git代码片段