markdown基础

markdown的原理是将纯文本转换为 html,从而获得更好的视觉效果。 但这里的“纯文本”本身就是有一定格式的,看起来就是很舒服的,经过转换效果更佳。
Github 中的 markdown 添加一些新语法,叫作 GFM(Github flavored markdown) 参考网址

常用样式: (可在源码中查看)




斜体

粗体

中划线

分层 1

分层 2

  1. 顺序
  2. 列表
  • 连续的
    • 无序
  • 列表

  • 独立的
  • 无序
  • 列表

一级标题

二级标题

三级标题

六级标题

横线


外部图片: picture_alt

本地图片: picture_alt

  • 可以给图片加尺寸
1
<img src="/assets/local_test_pic.png" alt="drawing" width="100" height="28"/>

drawing

  • 也可以只加宽度
    1
    <img src="/assets/local_test_pic.png" alt="drawing" width="100"/>
    

    drawing

表格标题 1 表格标题 2
表格项目 1.1 表格项目 1.2
表格项目 2.1 表格项目 2.2
1
2
3
/*
	代码段,可以设定语言类型进行语法高亮,不同生成器支持程度不同
*/

输入尖括号’<>’ 由于尖括号会被识别为 html 标签,所以无法正常显示。可以用&lt;&gt;替代

单行输入反引号`

1
`` ` ``

markdown 最佳实践

  • 在进行任务列表规划时,用 - [] 任务1 这种形式记录任务列表,当任务完成时可以标记为 - [x] 任务1,这样就可以模拟 checkbox 的功能。