一、前言
markdown是写文档的神器,没有xml的繁琐,通过plain text就可以快速完成格式化的文档编辑,通过简单的标志进行格式化,非常方便。另外,如果你想分享你用markdown写的文章,也只需要拷贝文本,而没有为了格式化而产生的二进制数据。
同时,简书也是支持markdown模式的,笔者在写这篇文章的时候就是用简书的markdown写的。
markdown的应用领域也越来越广泛,许多网站都支持markdown,包括 GitHub 、reddit等。
总而言之,就是用简单的文本完成格式化的文档。
二、斜体和加粗
1、斜体
斜体,我们只需要用下划线包围我们需要斜体的文本。
文本:
我是斜体
效果:
我是斜体
2、加粗
加粗,使用星号包围我们需要加粗的文本。
文本:
我是粗体
效果:
我是粗体
3、加粗和斜体
加粗和斜体,聪明的你肯定会想到使用星号和下划线包围需要格式化的文本,没错就是这样,而且先包围加粗和斜体都是允许的。
文本:
我是粗斜体 或者 我是粗斜体
效果:
我是粗斜体
三、标题
使用井号来标记标题的级数,写在标题的开头。
一级标题一个井号,二级标题两个井号,以此类推。
markdown一共支持6级标题。
文本:
#一级标题
##二级标题
###三级标题
####四级标题
#####五级标题
######六级标题
效果:
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
四、超链接
markdown支持两种超链接方式,分别是内联方式和引用方式
1、内联方式
由中括号和小括号组成,中括号是显示的内容,小括号是跳转的超连接地址
文本:
[搜索](www.baidu.com)
效果:
2、引用方式
引用方式需要先定义超链接地址,然后在别的地方进行引用。
一般用到的场景是,当我们的文档中有多个地方需要用同一个地址的超链接的时候,我们就可以先定义超链接的地址。而不需要每次都输入同一个超链接的地址。
当然,如果我们需要更改超链接地址的时候,也只需要更改定义的地方就行了。
文本:
[百度][siteA]是一个搜索引擎,[点击进入][siteA]
[简书][siteB]是一个写博客的地方,[点击进入][siteB]
(省略。。。)
[siteA]:www.baidu.com
[siteB]:www.jianshu.com
效果:
百度是一个搜索引擎,点击进入
简书是一个写博客的地方,点击进入
(省略。。。)
五、图片
图片和超链接非常相似,只是在前面加了个感叹号"!",同样有两种方式。
1、内联方式
文本:
![这是一张测试图片](https://img.haomeiwen.com/i9294298/14b378d1dee8fee4.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
效果:
这是一张测试图片2、引用方式
文本:
![这是一张测试图片][pic1]
[pic1]:http://octodex.github.com/images/founding-father.jpg
效果:
这是一张测试图片六、引用
引用用于强调某一段的内容,使用特殊的方式显示。
我们只需要在需要强调的段落前使用右尖括号。
如果需要子引号,则是两个右尖括号
文本:
>我是需要特殊显示的段落
>>我是子引用
效果:
我是需要特殊显示的段落
我是子引用
七、列表
我们在需要形成列表的文本前加上星号和空格,就可以显示成列表了
文本:
* 项目1
* 项目2
* 项目3
效果:
- 项目1
- 项目2
- 项目3
如果希望不是实心点而是数字,则把星号和空格改成数字和句号就行了。
文本:
1. 项目1
2. 项目2
3. 项目3
效果:
- 项目1
- 项目2
- 项目3
如果希望有二级列表,则在二级列表的星号前加空格即可。
文本:
* 项目1
* 子项目1
* 子项目2
* 项目2
* 项目3
效果:
- 项目1
- 子项目1
- 子项目2
- 项目2
- 项目3
八、段落
当我们按照平时的输入进行另起一行时,markdown并不会另起一行,而是把另起一行的文本显示在同一行。如果我们需要另起一行,则需要在文末添加两个空格。因为空格看不出来,所以我就不演示了。
九、Code
1、想要直接输出文本而不进行格式化,则只要在开头加入4个空格或者一个tab
效果:
-
Open the file.
-
Find the following code block on line 21:
String a = "";
-
Update the title to match the name of your website.
2、如果想要强调某个关键字词,则用刻度符号`包围
文本:
你好,`简书`!
效果:
你好,简书
!
如果你要强调的包含刻度符号,则用两个刻度包围他们
文本:
你好,``简书``!
效果:
你好,简`书
!
十、分割线
文本:
---
效果:
十一、表格
1、创建一个表格
使用3个以上的连字符来创建列表,使用 |隔开每一列
文本:
| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |
效果:
Syntax | Description |
---|---|
Header | Title |
Paragraph | Text |
表格不需要严格对齐,如下面这种也是可以的,而且显示效果和上面一样:
| Syntax | Description |
| --- | ----------- |
| Header | Title |
| Paragraph | Text |
2、表格的对齐方式
表格的对齐方式通过在连字符的左右增加冒号来表示
冒号在连字符左边则是左对齐
冒号在连字符的右边则是右对齐
冒号在连字符左右两边则是居中对齐
文本:
| Syntax | Description | Test Text |
| :--- | :----: | ---: |
| Header | Title | Here's this |
| Paragraph | Text | And more |
效果:
Syntax | Description | Test Text |
---|---|---|
Header | Title | Here's this |
Paragraph | Text | And more |
十二、高亮代码块
我们想要让引入一段代码,并且想要按照某种代码风格进行高亮显示。可以在代码块的开始和结束的地方使用三个连续的刻度号包围,并且在开始的三个刻度号后面注明代码风格。如果不注明,则只当块处理。
文本:
```java
public class Test{
public static void main(String[] args) throws IOException {
System.out.println("hello world!");
}
}
```
效果:
public class Test{
public static void main(String[] args) throws IOException {
System.out.println("hello world!");
}
}
网友评论