Skip to content

为更好地写md文档,美化你的文档,增强可读性!!

License

Notifications You must be signed in to change notification settings

Harrdy2018/Learning-README

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 

Repository files navigation

md文档攻略

为更好地写md文档,美化你的文档,增强可读性!!


Author Harrdy2018
Email [email protected]

目录


横线

连续输入---,***,___,可以显示横线效果,但是如果是---并且它的前一行是文字,则文字变成了一级标题





标题

  • 一级标题 # 一级标题
  • 一级标题 ===一级标题
  • 二级标题 ## 二级标题
  • 二级标题 ---二级标题
  • 三级标题 ### 三级标题
  • 四级标题 #### 四级标题
  • 五级标题 ##### 五级标题
  • 六级标题 ###### 六级标题

文本

普通文本

这是一段普通文本

单行文本

这是一段单行文本。在一行的开头加一个Tab或者4个空格。这是一段单行文本。在一行的开头加一个Tab或者4个空格。这是一段单行文本。在一行的开头加一个Tab或者4个空格。这是一段单行文本。在一行的开头加一个Tab或者4个空格。这是一段单行文本。在一行的开头加一个Tab或者4个空格。

多行文本

语法1
在连续几行的文本开头加入1个Tab或者4个空格。在连续几行的文本开头加入1个Tab或者4个空格。在连续几行的文本开头加入1个Tab或者4个空格。在连续几行的文本开头加入1个Tab或者4个空格。
在连续几行的文本开头加入1个Tab或者4个空格。在连续几行的文本开头加入1个Tab或者4个空格。在连续几行的文本开头加入1个Tab或者4个空格。在连续几行的文本开头加入1个Tab或者4个空格。
在连续几行的文本开头加入1个Tab或者4个空格。在连续几行的文本开头加入1个Tab或者4个空格。在连续几行的文本开头加入1个Tab或者4个空格。在连续几行的文本开头加入1个Tab或者4个空格。
语法2

使用一对3个Tab键上面的符号。

Hello,Baby!!
Hello,Baby!!
Hello,Baby!!

文字高亮

语法:

`Python3`,`JavaScript`,'Java'

效果:Python3,JavaScript,Java

换行

直接回车不能换行,
可以在上一行文本后面补两个空格   在行末位加<br>标签
这样下一行的文本就换行了。   或者就是在两行文本直接加一个空行。 也能实现换行效果,不过这个行间距有点大。

字体样式

  • 倾斜  *倾斜*
  • 倾斜 _倾斜_
  • 加粗 **加粗**
  • 加粗 __加粗__
  • 删除线 ~~删除线~~
  • 倾斜加粗   ***倾斜加粗***
  • 倾斜加粗删除线 ***~~倾斜加粗删除线~~***

引用

引用内容   >引用内容

引用内容 >>引用内容

引用内容 >>>引用内容


列表

  • 这是一个无序列表 * 这是一个无序列表
  • 这是一个无序列表 * 这是一个无序列表
  • 这是一个无序列表 - 这是一个无序列表
  • 这是一个无序列表 - 这是一个无序列表
  • 这是一个无序列表 + 这是一个无序列表
  • 这是一个无序列表 + 这是一个无序列表
  • 这是一个无序列表 * 这是一个无序列表
  • 这是一个无序列表 + 这是一个无序列表
  1. 这是一个有序列表 1. 这是一个有序列表
  2. 这是一个有序列表 2. 这是一个有序列表
  3. 这是一个有序列表 3. 这是一个有序列表

链接

md文档攻略


也可以直接用尖括号包含网址的方式<https://github.com/Harrdy2018/Learning-README/blob/master/README.md>来构成链接


https://github.com/Harrdy2018/Learning-README/blob/master/README.md


图片

像构造链接一样,格式为![图片信息](图片地址)
金所炫
也可以用html方式来指定图片大小<img src="" width="240px" height="240px" alt="jsx">
金所炫


程序代码

print("Hello")
>>>Hello

表格

  • 使用-|符号把内容分割为你认为合适的表格样式就好
  • 使用:符号标识对齐

表头1 表头2 表头3
左对齐 居中对齐 右对齐

保存

最后将markdown编写的文档保存为.md格式即可!!

About

为更好地写md文档,美化你的文档,增强可读性!!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages