Giter VIP home page Giter VIP logo

markdown's Introduction

Markdown

Awesome markdown usage:heartbeat:

目录

标题

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

效果

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

文本

普通文本

这是一行普通文本

单行文本

开头添加一个Tab或者4个空格

文本块

语法

  • 在连续的几行开头添加一个Tab或者4个空格
  • 或者使用三个反引号包括
第一行文本
第二行文本
第三行文本

文字高亮

使用一对反引号(`)包括起来

`linux`

效果

linux

换行

行尾添加两个空格或者两行之间空一行

显示横线效果

---
***
___

效果




斜体、粗体、删除线

汉字 效果
*斜体*或者_斜体_ 斜体
**粗体**或者__粗体__ 粗体
~~删除线~~ 删除线
***斜粗体***或者___斜粗体___ 斜粗体
*~~斜体删除线~~*或者_~~斜体删除线~~_ 斜体删除线
**~~粗体删除线~~**或者__~~粗体删除线~~__ 粗体删除线

列表

无序列表

-
+
*

效果

  • 无序列表
  • 无序列表
  • 无序列表

多级无序列表

- 一级列表
  - 二级列表
    - 三级列表

效果

  • 一级无序列表
    • 二级无序列表
      • 三级无序列表

有序列表

1.
2.
3.

效果

  1. 有序列表
  2. 有序列表
  3. 有序列表

多级有机列表

1. 一级有序列表
    1. 二级有序列表
        1. 三级有序列表
2. 一级有序列表
    1. 二级有序列表
        1. 三级有序列表
3. 一级有序列表
    1. 二级有序列表
        1. 三级有序列表

效果

  1. 一级有序列表
    1. 二级有序列表
      1. 三级有序列表
  2. 一级有序列表
    1. 二级有序列表
      1. 三级有序列表
  3. 一级有序列表
    1. 二级有序列表
      1. 三级有序列表

复选框列表

Tip

在GitHub的issue中使用该语法是可以实时点击复选框来勾选或解除勾选的,而无需修改issue原文

- [x] 需求分析
- [x] 系统设计
- [x] 详细设计
- [ ] 编码
- [ ] 测试
- [ ] 交付

效果

  • 需求分析
  • 系统设计
  • 详细设计
  • 编码
  • 测试
  • 交付

块引用

引用文本

> 引用文本内容

效果

引用文本内容

块引用多级结构

> 数据结构
>> 
>>> 二叉树
>>>> 平衡二叉树
>>>>> 满二叉树

效果

数据结构

二叉树

平衡二叉树

满二叉树

代码块

```[编程语言]
code
```结束

效果

function consoleIt(param) {
  console.log(param);
}

表格

简单表格

表头 | 表头 | 表头
----|------|----
内容 | 内容 | 内容
内容 | 内容 | 内容
内容 | 内容 | 内容

或者美观一些

| 表头 | 表头 | 表头 |
|-----|------|-----|
| 内容 | 内容 | 内容 |
| 内容 | 内容 | 内容 |
| 内容 | 内容 | 内容 |

效果

表头 表头 表头
内容 内容 内容
内容 内容 内容
内容 内容 内容

对齐文本

| Left-Aligned  | Center Aligned  | Right Aligned |
| :------------ |:---------------:| -----:|
| col 3 is      | some wordy text | $1600 |
| col 2 is      | centered        |   $12 |
| zebra stripes | are neat        |    $1 |

效果

Left-Aligned Center Aligned Right Aligned
col 3 is some wordy text $1600
col 2 is centered $12
zebra stripes are neat $1

链接

简单链接

<URL>或者<Email>

效果

https:///www.baidu.com
[email protected]

一般链接

[name](URL title)

  • name显示的链接文字
  • title鼠标悬浮显示的文字
[百度一下,你就知道](https://www.baidu.com "百度一下,你就知道")

效果

百度一下,你就知道

图片链接

[![百度一下,你就知道](https://www.baidu.com/img/bd_logo1.png "百度一下,你就知道")](https://www.baidu.com)

效果

百度一下,你就知道

锚点

  • 每一个标题都是一个锚点
  • 标题中的英文字母都被转化为小写字母
  • 可以链接中文锚点
[回到顶部](#readme)

效果

回到顶部

图片

基本格式

![alt](URL title)

  • alt表示图片显示失败时的替换文本
  • title表示鼠标悬停在图片时的显示文本(注意这里要加引号)
![百度一下,你就知道](https://www.baidu.com/img/bd_logo1.png "百度一下,你就知道")

效果

百度一下,你就知道

GitHub

diff

+++ new commit line change
--- old line

使用Css样式

折叠

使用detailssummary来实现折叠,点击此处查看具体文档

Details
```js
function hello() {
  console.log('this is in details block')
}
```

markdown's People

Contributors

hom avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.