【开发技巧】-- MarkDown使用文档

1. MarkDown使用文档

1.1 什么是MarkDown?

MarkDown是一种非常简单的标记语言,它非常适合于程序员使用因为它支持很多非常好用的基础语法,并且它非常方便使用。

1.2 为什么要使用MarkDown编写文档?

说到编写文档我们最先想到的一定会是Word文档,但是对于我们程序员而言,我们的文档中往往都会有代码块、图片应用等一些文档元素,而Word文档对于代码块的处理支持的不是那么好,而MarkDown为我们解决了这样的问题,它支持插入代码高亮显示。

1.3 快速入门MarkDown

1.3.1 标题标记

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

<h1>-<h6>标签也可使用

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

1.3.2 列表标记

#无序列表
* 一级列表
  * 二级列表
  
- 一级列表
  - 二级列表
  
# 有序列表
1. Java是一门跨平台的语言
2. Spring是一个轻量级的开源框架
3. SpringBoot基于Spring框架,它提供了一种快速使用Spring的方式
  
或者使用html原生的<ul> <ol> <dl>
  • 一级列表
    • 二级列表
  • 一级列表
    • 二级列表
  1. Java是一门跨平台的语言
  2. Spring是一个轻量级的开源框架
  3. SpringBoot基于Spring框架,它提供了一种快速使用Spring的方式

1.3.3 标记关键字

`关键字` tab键上边那个符号`

关键字
Java是一门跨平台的语言

HTML是一门标记语言

1.3.4 重点标记

==重点内容==

重点内容

花花

1.3.5 字体加粗标记

**字体加粗**

字体加粗

1.3.6 代码块

​```java/javascript/python/C#/C++/C/GO/html/properties/yml/yaml
public class Test{
     
  public static void main(String[]args){
     
    System.out.println("Hello World!");
  }
} 
​```
public class Test{
     
  public static void main(String[]args){
     
    System.out.println("Hello World!");
  }
} 

1.3.7 引入图像标记

![华晨宇](https://bkimg.cdn.bcebos.com/pic/3ac79f3df8dcd1009a1b50b8748b4710b8122fa7?x-bce-process=image/resize,m_lfit,h_168,limit_1)

【开发技巧】-- MarkDown使用文档_第1张图片

1.3.8 链接标记

(华晨宇)[https://baike.baidu.com/item/%E5%8D%8E%E6%99%A8%E5%AE%87/6064097?fr=aladdin]

华晨宇

1.3.9 水平线标记

---------

1.3.10 待办事项标记

- [x] 已完成的工作
- [ ] 待办事项1
- [ ] 待办事项2
  • 1231

  • 待办事项1

  • 待办事项2

1.3.11 表格标记

| 表头 |    |   |
|-----|----|----|
|     |    |    |
表头

你可能感兴趣的:(心得分享,开发技巧)