markdown用法总结

markdown用法详解

Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。最近在使用markdown整理笔记的时候,简直对它爱不释手,因此来整理一下markdown 的基本使用方式,简直是程序员写作的一大神器,强烈推荐上手学习。本次分享的内容主要有以下四点。

[TOC]

markdown的由来

markdown的创作者是亚伦·斯沃茨(Aaron Swartz),他发明了这种简单易用的富文本标记语言。
这个语言的目的是希望大家使用“易于阅读、易于撰写的纯文字格式,并选择性的转换成 有效的XHTML(或是 HTML)”。帮助我们实现易读易写的功能,快速上手使用。

markdown常用的编辑器推荐

1.马克飞象

由于印象笔记Windows客户端暂不支持markdown文本编辑,所以许多使用印象笔记的程序猿就很蛋疼。好在马克飞象帮我们解决了这个问题,它可以帮我们将文本同步到印象笔记中(注意这不是打广告),我最近也一直在使用马克飞象进行笔记总结。有多个主题和详细的使用文档可以查看,用户体验还不错。

2.小书匠

一款全平台覆盖的markdown文本编辑器,并且有在线web版,功能很强大。对于不愿折腾的人来说,使用很方便,打开浏览器就可以轻松使用。

3. 简书

简书很早就开始支持markdown语法,并且强烈推荐使用,我们直接可以在简书编辑好发布我们的文章,一气呵成。

4. 掘金

一个开发者技术交流平台,支持markdown语法进行创作。

5.MarkdownPad

MarkdownPad 一款全功能的编辑器,被很多人称赞为windows 平台最好用的markdown编辑器。但是界面是英文,怕很多使用者不喜欢。

markdown的基本用法

说了这么早,终于到正题了。下面开始介绍markdown的基本用法,保证你看完之后很快上手。

1.标题

在需要设置标题的文字前面加#来形成标题。在#结束的时候添加空格和标题 分开,最多支持六级标题。下面是实例。

// 示例
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
2.字体

字体的用法主要有斜体,加粗,斜体加粗,加删除线

  • 加粗
    前后两个*将文字包裹起来
    这是加粗的文字
//示例
**这是加粗的文字**
  • 斜体
    前后一个*将文字包裹起来
    这是斜体文字
//示例
*这是斜体的文字*
  • 斜体加粗
  • 前后三个*将文字包裹起来
    斜体加粗
//示例
***这是斜体加粗的文字***
  • 删除线
    添加删除线
//示例
~~这是添加删除线的文字~~
3.引用

在引用的文字前加>即可。引用也可以嵌套,如加两个>>三个>>>,可以一直嵌套下去,只需要继续添加>即可

  • 不加嵌套的引用

引用1
引用2
引用3

// 示例
>引用1
>引用2
>引用3
  • 添加嵌套的引用

引用1

引用2

引用3

// 示例
>引用1
>>引用2
>>> 引用3
4.为上下文添加分割线

需要注意的是至少需要三个同样的符号以上。




// 以下几种都可以
---
----
***
*****
5.图片
image
![图片标题](图片地址 "图片描述")
图片标题就是显示在图片下面的文字,相当于对图片内容的解释,也可以不加。
图片描述,当鼠标移到图片上时显示的内容。title可加可不加,不是所有的编辑器都支持

// 示例
![图片](http://i2.hdslb.com/bfs/archive/e1b84c93ffaf005a96fca22dc253557d9692f6b8.jpg "这是一张图片")
6.超链接

百度
行内链接马克飞象

// 示例
[百度](http://baidu.com)
行内链接[马克飞象](https://maxiang.io/)

7.代码

markdown语法很好的支持嵌入代码和代码块,极大方便了程序员写作和记笔记
这是单行代码

//示例
这是`单行代码`

这是代码块

  bezierAnimator.setDuration(10000);
        bezierAnimator.addUpdateListener(new                ValueAnimator.AnimatorUpdateListener() {
            @Override
            public void onAnimationUpdate(ValueAnimator valueAnimator) {
                PointF pointF = (PointF) valueAnimator.getAnimatedValue();
                // 不断改变视图的位置
                iv.setX(pointF.x);
                iv.setY(pointF.y);
            }
});
// 示例
这是`单行代码`
用一对``包裹

这是代码块
用三个```代码块```包裹
8.列表
  • 无序列表
    无序列表用 - + * 任何一种都可以,注意文字前加空格

  • 列表1

  • 列表2

  • 列表3

// 示例
- 列表1
- 列表2
- 列表3
  • 有序列表
    数字加点,注意文字前加空格
  1. 列表1
  2. 列表2
  3. 列表3
// 示例
1. 列表1
2. 列表2
3. 列表3
  • 组合使用
    子列表每行缩进3个以上空格

  • 列表1
    1. 列表1
    2. 列表2
    3. 列表3

// 示例

  • 列表1
    1. 列表1
    2. 列表2
    3. 列表3
9.表格
表头 表头 表头
左对齐 居中 右对齐
内容 内容 内容

第二行分割表头和内容。
- 有一个就行,为了对齐美观
文字默认居左
-两边加:表示文字居中
-右边加:表示文字居右

// 示例
表头|表头|表头
---|:--:|---:
内容|内容|内容
内容|内容|内容

表格换行

表格换行:加<br>
表头|表头|表头
---|:--:|---:
内容|内容 <br> 内容|内容
内容|内容|内容

// 示例

表头 表头 表头
内容 内容
内容
内容
内容 内容 内容
10.反斜杠

用\来实现转义字符的效果
\
!
{}

// 示例
\\ 反斜线
\` 反引号
\* 星号
\_ 底线
\{ 左花括号
\} 右花括号
\[ 左方括号
\] 右方括号
11.自动生成目录

使用[TOC]来生成,可能有些编辑器不能支持,马克飞象可以支持。

[TOC]

// 示例
[TOC]
12.自动链接

自动链接只要是用尖括号包起来,就会自动被转成链接。一般网址的链接文字就和链接地址一样。
http://baidu.com
另外一种添加描述的链接示例如下,不显示链接地址
最大子序和

// 示例
<http://baidu.com>
// 添加描述的链接
[最大子序和](https://leetcode-cn.com/problems/maximum-subarray/ "超链接title")

基本的markdown语法就介绍到这里,相信已经可以满足98%的写作需求,至于添加流程图和插入公式的不常用的用法就不介绍了,百度一下可以知道。**

markdown相关文档推荐

http://www.appinn.com/markdown/

https://www.jianshu.com/p/191d1e21f7ed

https://www.jianshu.com/p/a17a8fa10e4a

推荐阅读更多精彩内容

  • 简书Markdown总结笔记 ——献给初次写作的朋友 前提说明 通过使用简书提供的Markdown方法,作者可以方...
    攻城狮也疯狂阅读 790评论 1 3
  • 1. Markdown是什么 简单来讲,Markdown就是一种标记语言,简单方便。 最大的优点是,在如今各种强大...
    忧忧自恼阅读 130评论 0 0
  • 欢迎关注微信公众号:北岛向南(id:nanzhouie) GitHub Pages:https://zhouie....
    zhouie阅读 3,624评论 5 73
  • 程序员大多都是强迫症患者,我现在感觉自己的病也是越来越重了,因为自己对平时的笔记排版也很看重(难道自己真的要成为一...
    Wizey阅读 2,724评论 24 131
  • 在前端编程中,少不了用到异步。提一个本人在之前实际编程遇到的问题(ajax):在独立的js文件中写统一提交ajax...
    摸摸大海参阅读 1,109评论 0 0