add: READMD.md
简要介绍 Markdown 的基本语法
This commit is contained in:
@@ -0,0 +1,140 @@
|
||||
# 这是一个测试仓库
|
||||
|
||||
这里支持 Markdown 语法,后缀为 `.md` 的文件均可以直接渲染出来
|
||||
|
||||
其中,目录下的 `README.md` 文件(文件名不区分大小写)将会渲染到仓库对应页面
|
||||
|
||||
# Markdown Format Test
|
||||
|
||||
```markdown
|
||||
# Markdown Format Test
|
||||
```
|
||||
|
||||
## 标题 2
|
||||
|
||||
```markdown
|
||||
## 标题 2
|
||||
```
|
||||
|
||||
### 标题 3
|
||||
|
||||
```markdown
|
||||
### 标题 3
|
||||
```
|
||||
|
||||
**这是粗体**
|
||||
_这是斜体_
|
||||
又粗又斜
|
||||
~~这是删除线~~
|
||||
|
||||
```markdown
|
||||
**这是粗体**
|
||||
_这是斜体_
|
||||
又粗又斜
|
||||
~~这是删除线~~
|
||||
```
|
||||
|
||||
[这是链接的显示文本](https://www.example.com/这是你要跳转到的链接)
|
||||
|
||||
```markdown
|
||||
[这是链接的显示文本](https://www.example.com/这是你要跳转到的链接)
|
||||
```
|
||||
|
||||

|
||||
|
||||
```markdown
|
||||

|
||||
```
|
||||
|
||||
- 这是列表项 1
|
||||
- 这是列表项 2
|
||||
- 这是嵌套列表项
|
||||
|
||||
```markdown
|
||||
- 这是列表项 1
|
||||
- 这是列表项 2
|
||||
- 这是嵌套列表项
|
||||
```
|
||||
|
||||
1. 这是有序列表项 1
|
||||
2. 这是有序列表项 2
|
||||
3. 这是有序列表项 3(不用担心,标准 markdown 语法会自动纠正错误的连续序号)
|
||||
|
||||
```markdown
|
||||
1. 这是有序列表项 1
|
||||
2. 这是有序列表项 2
|
||||
3. 这是有序列表项 3(不用担心,标准 markdown 语法会自动纠正错误的连续序号)
|
||||
```
|
||||
|
||||
这是 `行内代码`
|
||||
|
||||
```markdown
|
||||
这是 `行内代码`
|
||||
```
|
||||
|
||||
```python
|
||||
# 这是代码块
|
||||
# 块中的 python 改成你需要的语言就能获得对应的代码高亮功能
|
||||
# 语言说明是可选项,默认是 plaintext(纯文本)
|
||||
# 注意,实际不需要输入 \,该字符用于转义
|
||||
def hello():
|
||||
print("Hello, world!")
|
||||
```
|
||||
|
||||
```markdown
|
||||
\`\`\`python
|
||||
|
||||
# 这是代码块
|
||||
|
||||
# 块中的 python 改成你需要的语言就能获得对应的代码高亮功能
|
||||
|
||||
# 语言说明是可选项,默认是 plaintext(纯文本)
|
||||
|
||||
def hello():
|
||||
print("Hello, world!")
|
||||
\`\`\`
|
||||
```
|
||||
|
||||
> 这是引用文本
|
||||
>
|
||||
> > 这是引用文本的引用
|
||||
> >
|
||||
> > > 以此类推
|
||||
|
||||
```markdown
|
||||
> 这是引用文本
|
||||
>
|
||||
> > 这是引用文本的引用
|
||||
> >
|
||||
> > > 以此类推
|
||||
```
|
||||
|
||||
这是表格:
|
||||
|
||||
| 靠左表头 1 | 居中表头 2 | 靠右表头 3 |
|
||||
| :----------- | :----------: | -----------: |
|
||||
| 靠左单元格 1 | 居中单元格 2 | 靠右单元格 3 |
|
||||
|
||||
```markdown
|
||||
| 靠左表头 1 | 居中表头 2 | 靠右表头 3 |
|
||||
| :----------- | :----------: | -----------: |
|
||||
| 靠左单元格 1 | 居中单元格 2 | 靠右单元格 3 |
|
||||
```
|
||||
|
||||
分割线:
|
||||
|
||||
---
|
||||
|
||||
```markdown
|
||||
---
|
||||
```
|
||||
|
||||
其实 Markdown 支持<b>直接渲染</b>部分 <i>HTML</i> 语法
|
||||
|
||||
```html
|
||||
其实 Markdown 支持<b>直接渲染</b>部分 <i>HTML</i> 语法
|
||||
```
|
||||
|
||||
# 尾巴
|
||||
|
||||
就先写到这里吧,掌握这些用法应该就足够了,其它的就是撰写规范了
|
||||
Reference in New Issue
Block a user