Skip to content

springyea/Markdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 

Repository files navigation

GitHub Markdown 语法

主要语法

标题

使用不同数量的#表示不同的级数标题
例子:

# 一级标题
###### 六级标题

效果:

一级标题

六级标题

强调

例子:

**这一句会变粗** (或者使用 __加粗__) 
*这一句是斜体* (或者使用 _斜体_) 
***加粗变斜***
~~删除线~~

效果:
这一句会变粗
这一句是斜体
加粗变斜
删除线

换行

在一句话后面加两个空格或空一行再加回车来换行
例子:

我后面有两个空格  
我是第二行  

效果:
我后面有两个空格
我是第二行

引用块

例子:

引用块使用数量不同的 > 来表示,可以使用多个>
> 父引用
>> 子引用

效果:

父引用

子引用

行内代码

使用两个反单引号表示 ``
例子:

这是我的`github`

效果:
这是我的github

链接

例子:
[显示文本](url链接)
效果:
GitHub

图片

在链接的符号钱前面加一个!即可
例子:
![文本](url链接)
效果:
Image of GitHub

章节链接

例子:

[返回标题处](#标题)
其中锚点为英语,单词全小写,中间有空格的话,用-代替

效果:
返回到标题处

相对链接

连接到本项目的其他文件中,和链接写法一样,url中写文件的跟地址

列表

无序列表

*以及-表示无序列表,符号后面有空格
例子:

* 第一行  
* 第二行

效果:

  • 第一行
  • 第二行

有序列表

直接使用 1. 2.表示
例子:

1. 第一行
2. 第二行

效果:

  1. 第一行
  2. 第二行

任务清单

使用 - [ ] tasks来表示任务清单,括号中x表示已完成,注意空格
例子:

- [X] 完成任务  
- [ ] 提交到github

效果:

  • 完成任务
  • 提交到github

创建表格

例子:

|标题1|标题2|  
|---|---|
|内容一|内容二|
左对齐 :---
居中: :---:
右对齐: :---:

效果:

标题1 标题2
内容一 内容二

代码块

保持文本的本来格式, 用三个` 开始以及结束。后面加编程的名字,可以编程的关键字高亮展示。
或者在代码前面使用四个空格。

\```编程语言名字
你的代码
\```
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html

转义符

使用\将一些特殊符号转义成为普通符号

HTML标签

支持HTML标签,是不是全部不太清楚。

如空格&nbsp;换行<br>;水平线<hr>等

帮助文档

About

Markdown主要语法介绍

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published