引言:我要是能想出来这东西,我都找到
女朋友
了。反正非常有用就行了!Readme.md文档
和日常博客
、日报笔记
之类的写的贼方便.方便就方便在它是文本标记语言,整篇文档下来不需要鼠标即可进行(那是不可能的,除非你不复制粘贴不做其他小动作)。
下面呢展示一些Markdown的一些经常用到的语法。其他的请自行学习,独秀同志不要闹我们马上开课啦(这里该有一个骚骚的表情包可惜我没有QAQ)。
1. 标题
标题标记是最基本的标记,因为我们基本上做什么都要先起标题。
该标记由#构成。标记由大到小对应#号由多变少一共六个挡位,自由变档无顿挫感,别克***。
咳咳。上面那个标题就是一个#构成的。
再有一点强调就是一定要注意很多标题和文字中间需要加空格,如果没有出来效果文档就增加空格试一下,切记不要拍桌子
,它会疼
2. 文字加粗
不说啦不说啦 这个很简单我变粗了就好啦。(星星+你要写的+星星)
就像这样**我细下来拉**
3. 文本替换超链
比如你想要关注我你就需要点这里。哇,介么神奇。只需要
[文本](超链)
即可轻松拥有,你还在等什么,赶快关注我呀大爷们/(ㄒoㄒ)/~~
关注后再给你看一个大宝贝[文本](超链 "超链标题")
这样就可以实现鼠标放置出现超链标题拉
4. 代码高亮
如果不想让自己的代码粘贴上来
平平无奇
,那么就一定要记住这个标记(用一下标记吧,直接粘上来的代码眼睛直接都花了)。
支持大部分语言的代码高亮,只需要将java换成对应语言的小写名称即可,当然也可以直接是文档换成text就好啦
##比如
public static void main(String[] args){
System.out.println("我是只居");
}
5. 添加图片
比如我加一个派大星。
![派大星](https://img-blog.csdnimg.cn/20200305193243214.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hlMTE1NDkxMDk0MQ==,size_16,color_FFFFFF,t_70 “鼠标悬停图片标题”)
当然这砸够,我要是想让图片是个超链也可以,我就套娃,套娃就行啦,我外面再套一个超链的。欸嘿嘿,真香!套不上去,***csdn老打断我。超链没放进来都开始下图片
[![图片说明](图片地址 图片标题)](超链地址 "超链标题") 这里会优先显示图片标题
6. 列表
列表也是我们经常用的一个拉,比如list。咳咳ArrayList和LinkedList的区别。咳咳就是类似于
<ol>
,<ul>
标签
1. 有序列表
即1.
数字小数点和空格组合。一定记住空格
2. 无序列表
无需列表可使用的标记有三个, -
*
+
,当它们为二级列表时,加一个缩进前面的点将为空心圆,最多三层到实心方块结束
- 减号
- 继续减号
- 继续
- 星号
- 继续星号
- 加号
- 继续加号
7. 重点文字高亮标记
``,ESC下面1左面哪个波浪线在英文下就是这个反引号号,两个这个可以将圈中文字高亮,并且
所有Markdown标记均!失!效!
,记好了偶
8. 扩展:项目结构编写
害,想起来这个我都能想到
bilibili
,我就联想到github。我都又想起来GO语言了。真神奇(这里补一个骚图)
你可以通过这个来描述项目结构,可以让观看者更直观的了解项目各部分的功能。也可以用这个展示工程架构。
我的项目
├── auth -- 授权服务提供
├── common -- 常用工具封装包
├── gateway -- 网关
├── ops -- 运维中心
├ ├── monitor -- 监控模块
├── service -- 业务模块
├ ├── system -- 系统模块
├ └── user -- 用户模块
├── service-api -- 业务模块api封装
├ ├── dict-api -- 字典api
├ ├── system-api -- 系统api
└── └── user-api -- 用户api
9. 我都忘了我写引言的标记了
>
空格不能丢奥,不然桌子该疼了
10. 转义
因为Markdown把好多符号都征用站岗去了了,那我们要用咋办捏,人家也想要动一动呢。那就转义好啦。暂时让它粗来帮你一下下
Markdown 使用反斜杠转义特殊字符
这些是支持转义的
\ 反斜线
` 反引号
* 星号
_ 下划线
{} 花括号
[] 方括号
() 小括号
# 井字号
+ 加号
- 减号
. 英文句点
! 感叹号
结束语
你以为到这里就完了吗,这只是markdown的基本功能嗷。你才光会写呢。markdown还能画。你问我能画啥?
表格
,数学公式
,流程图
,甘特图
,时序图
它都能完成。我的天哪!瞬间被满足了呢!
咳咳,我的陈述完毕。法官大人,我真的只是在学习呀。