Markdown备忘录

关于markdown实操备忘录

引言:

使用markdown编写文档,可以快速生成 排版格式良好、可读性强的文档,目前大部分博客,都是基于该方法去编辑生成。
在学习和使用markdown之前,了解html(超文本标志语言)和 XML(可扩展标志语言)的概念, 对使用markdown有很大帮助。 二者的语法十分接近, 只是使用场合不一样,存在一些细节上的语法差异。

  1. XML主要用来描述数据,比如数据库中,数据描述和数据传输的使用场合, ROS系统gazebo当中,用于描述模型数据。Sysrepo当中用于描述页面配置的数据。
  2. HTML 应用于显示数据和显示数据外观,也就是描述我们的网页框架。
  3. 而markdown 和HTML的关系则更为接近,** Markdown 可算是 HTML 的一个简化了标记形式的子集。**,所以当我们使用markdown 编辑时,有些文本,图像等内容无法较为理想地表现出来的时候,我们便可以使用HTMl 进行矫正补充。
  4. Windows这两年做的VisualStudioCode不错, 可以编辑很多代码语言,插件丰富,启动速度快,终端命令输入,跨平台,完全免费,可以支持很多插件:
    Markdown Preview Mermaid Support 支持绘制思维导图
    Markdown Preview Enhanced 效果预览
  5. 在需要表达特别多级的内容的时候,不建议一味地使用* ,# 等操作符。可以标识具体数字,比如

    2

    2.1

    2.2

    这样表述观点,会直观得多,免得过多项目, 后面分不清有几点内容。

简记:

  • 六级标题: ###### 标题 (注意内容和标识符之间有小空格,六级就是正常字体加粗)
    标题
  • 五级标题: ##### 标题
    标题
  • 四级标题:#### 标题

    标题

  • 三级标题:### 标题

    标题

  • 二级标题:## 标题

    标题

  • 一级标题:# 标题

    标题


  • 文字倾斜: *文字*
    文字

  • 文字加粗: **文字**
    文字

  • 文字加粗并倾斜: ***文字***
    文字

  • 换行: 空格+空格+回车

  • 突出内容,加上背景阴影: ` 内容 `
    内容

  • 高亮内容: ==内容==
    内容

  • 插入链接: <https://editor.csdn.net/>
    https://editor.csdn.net/

  • 给链接取名字: [CSDN](https://www.csdn.com)
    CSDN

  • 插入图片:
    ![图片](https://www.csdn.com) 网页链接
    ![图片](./) 本地相对路径
    ![图片](base64压缩码) 通过base64 压缩图片得到的编码,html中有的图片也是通过这种形式加入的,太丑了,整个插入的压缩码看起来十分冗长。

  • 使用编程语言和特殊格式来插入内容:

```c [ c++, sh, python, js …etc ]
int main()
{return 0;}
```

	C代码
	int main()
	{return 0;}
  • 当markdown中的特殊字符已经被markdown 赋予用途的时候, 而又想使用的时候,通过
    用反斜杠\ 来转义。
\#  显示#号  
\>  引用的作用被消除, 表示字符 ">"。

使用思维导图, 饼形图

官网教程: https://mermaid-js.github.io/mermaid/#/

```mermaid
graph LR; LR 表示从左到右展开, TB 表示从上到下展开
A–>B;
A–>C;
```

  • 逻辑图
A
B
C
  • 时序图
    AliceBobJohnHello John, how are you?Fight against hypochondrialoop[ Healthcheck ]Rational thoughts prevail!Great!How about you?Jolly good!AliceBobJohn
  • 圆饼图
  • 甘特图(横条图), CSDN 不支持甘特图。 用来表达网络页面的加载流程,NICE!
  • 类归属图, 面向对象语言的类函数继承说明。
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章