Skip to content

wind36830/MarkdownLearning

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 

Repository files navigation

Markdown 培训

什么是Markdown

为什么使用Markdown

如何使用Markdown

使用工具

什么是Markdown

官方的定义是Markdown是一种轻量级标记语言,它以纯文本形式(易读、易写、易更改)编写文档,并最终以HTML格式发布。 Markdown也可以理解为将以MARKDOWN语言编写的语言转换成HTML内容的工具,最初是一个perl脚本Markdown.pl。

为什么使用Markdown

它是易读(看起来舒服)、易写(语法简单)、易更改纯文本。

兼容HTML,可以转换为HTML格式发布。

跨平台使用。

是目前软件文档的主要格式。

越来越多的网站支持Markdown。比如github等网站

许多技术博客使用的语言

如何使用Markdown

标题

标题的表示有两种方式

两种形式: 1)使用=和-标记一级和二级标题。

一级标题

=========

二级标题

---------


效果:

一级标题

二级标题


2)使用#,可表示1-6级标题。

# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题

###### 六级标题


效果:

一级标题

二级标题

三级标题

四级标题
五级标题
六级标题

段落

段落的前后要有空行,所谓的空行是指没有文字内容。若想在段内强制换行的方式是使用两个以上空格加上回车(引用中换行省略回车)。


区块引用

在段落的每行或者只在第一行使用符号>,还可使用多个嵌套引用,如:

> 区块引用

>> 嵌套引用


效果:

区块引用

嵌套引用


代码区块

如果你想要把写好的代码作为一个区块写入文档中可以使用 "`" 来把代码包起来。或者高亮某个文字。

` Console.WriteLine("Hello World") '

效果: Console.WriteLine("Hello World) 也可以用三个`来包裹一个代码区块

``` public static void main() { Console.WriteLine("Hello, World."); }

```


效果:

 public static void main()
{
Console.WriteLine("Hello, World.");
}

也可以在 ```之后写上所用的语言```C#,不同的markdown会根据不同的语言来进行高亮(不一定所有的markdown解析器都适用)

 public static void main()
{
Console.WriteLine("Hello, World.");
}

强调

在强调内容两侧分别加上*或者_,如:

*斜体*,_斜体_

**粗体** __粗体__

效果:

斜体斜体 粗体粗体


####列表

使用·、+、或-标记无序列表,如:

-(+) 第一项 -(+) 第二项 - (+*)第三项 注意:标记后面最少有一个空格或制表符。若不在引用区块中,必须和前方段落之间存在空行。

效果:

  • 第一项
  • 第二项
  • 第三项 有序列表的标记方式是将上述的符号换成数字,并辅以.,如:

1 . 第一项 2 . 第二项 3 . 第三项

实际上序号上的数字可以随便填写 但是建议以1开头,为以后的特性做适应 效果:

  1. 第一项
  2. 第二项
  3. 第三项

分割线

分割线最常使用就是三个*以上就可以。


链接

链接可以由两种形式生成:行内式和参考式。

基本语法是 如果是本地资源可以使用相对路径 行内式: [百度](baidu.com) [关于](/about) 效果:

百度 关于

参考式:

[百度][1]

[github][2]

[1]:baidu.com "百度"

[2]:github.com "github" 注:[2]:github.com "github"可以放在文本的任何位置,建议紧跟链接方便日后更改。

效果:

百度

github


图片

添加图片的形式和链接相似,只需在链接的基础上前方加一个!。

![百度](/1.png) 效果如下:

百度 但是marMarkdown并不能调节图片大小和位置,如果有需要可以使用<img/> 标签


反斜杠\

相当于反转义作用。使符号成为普通符号。当有一些marMarkdown的特殊符号时可以进行转义,


表格

由于表格的语法不是原生markdown的语法,所以可能会在某些markdown解析器中不适用。

表格的语法相对来说比较繁琐,用 | 来当作管道作为分隔 在表头的下一行作为与内容的分隔

中间的分隔符作为对齐的表示 :-------表示左对齐(或者不用加:) :-----: 表示居中对齐 ------:表示右对齐。

| Tables | Are | Cool |

| ------------- |:-------------:| -----:|

| col 3 is | right-aligned | $1600 |

| col 2 is | centered | $12 |

| zebra stripes | are neat | $1 |

效果如下:

Tables Are Cool
col 3 is right-aligned $1600
col 2 is centered $12
zebra stripes are neat $1

windows一些常用的工具

visual studio Code  
MarkdownPad
Typora
简书



About

A short teach About Learning Markdown

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published