Markdown Memo

引言:

使用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 效果预览
    Mermaid 绘制思维导图必备插件,目前可以使用Markmap插件,该插件更加容易美观,易上手。
    Markdown all in one 省去markdown大部分配置安装
  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压缩码,部分html网页就采用该形式。 ![图片描述](base64压缩码)

  • 划去内容文本: ~~划去内容文本~~
    划去文本内容

  • 分隔符: - - -


  • 使用编程语言和特殊格式来插入内容:注意该语法工具,可以进行空格缩进, 来确保和标题对齐。

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

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

使用思维导图, 饼形图

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

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

  • 逻辑图
A
B
C
  • 时序图
    Alice Bob John Hello John, how are you? Fight against hypochondria loop [Healthcheck] Rational thoughts prevail! Great! How about you? Jolly good! Alice Bob John
  • 圆饼图
  • 甘特图(横条图), CSDN 不支持甘特图。 用来表达网络页面的加载流程,NICE!
  • 类归属图, 面向对象语言的类函数继承说明。

在markdown中使用思维导图markmap插件

在vscode可直接安装, 需要将文件保存为 file.mm.md, 只有这样的文件格式,markmap才能够被markdown插件准确识别并展示出来。
markmap根据#等标志来建立一级分叉节点以及二级分叉节点, 根据-以及*来列多个知识点。
在这里插入图片描述

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值