
简介:本文会简要介绍Markdown并且说明在立创开源平台的应用
Markdown使用说明
本文主要介绍
- 什么是Markdown
- 为什么推荐使用Markdown
- 在立创如何应用Markdown
- 常用语法说明
1. 什么是Markdown
Markdown 其实是一种轻量级的标记语言,使用特定的标记符即可使文字有一定的格式,简捷、高效、通用,五分钟即可上手,是一种可以彻底学会的语言,不仅能帮我们极大地提高写作效率,而且能大幅提升文档的美观性,是一种非常推荐使用的语言。
例如
- 做小标题,只需要在标题名称前加对应个数的 # :
### 标题测试
效果如下:
标题测试
- 想要做条链接,只需要使用 [ 想要显示的文本 ] (链接) 组合 :
[立创开源平台](https://oshwhub\.com/)
效果如下:
2.为什么要使用Markdown
- 写作遇到的问题:
- 格式编辑烦:常规写作,编辑格式往往使用的是word中方法,先打字,选中,再设置格式,编辑功能按钮也可能找不见,繁琐且效率低下。
- 排版混乱:常规写作,想要界面美观一些,往往需要对文本设置加粗,倾斜,行间距等,否则文章密密麻麻分不清,没有层次感。
- 兼容性不好:例如,我想把工程开源到 Github,常规语法写的文档,可能复制粘贴之后格式混乱,呈现的是一篇错落不堪的文档,完全不是当初的样子,又不得不重新排版。
- Markdown足够的优点:[易读易写]
- 格式编辑简洁:借助于特定语法,我们只需要专注于写作的内容,不必在关心格式的编辑问题。
- 排版简洁:特定的符号对应着特定的排版,可能只需要两个符号就帮你做好完美的排版,例如文字大小,粗细,行间距等等
- 兼容性极强:Markdown是一种世界上都非常通用的语法,只要双方编辑器支持,在一方用Markdown写的文档粘贴到另一方后,仍然是一样的漂亮美观,彻底解决混乱问题。
- 当然,它的优点还有很多,这里只简单介绍了3个。
3. 立创上如何应用 Markdown
立创的文档编辑器同样支持Markdown,而且支持左右栏实时预览,这里,以一个工程举例。
- 首先,先选择一个开源工程,然后确定其他项。
- 在文档编辑界面,先选择Markdown,然后选择全屏编辑。
- 点击右下角的一行小字 “Markdown”
- 完成,即可编辑
4. 常用句法说明
这里,我会列出一个表格,并通过 gif 图 演示
Markdown 语 法 | 注 解 | 效 果 |
---|---|---|
** 粗体 ** | 左右各两个 * | 粗体 |
*斜体* | 左右各一个 * | 斜体 |
# 一级标题 | # 后需要一个空格 | 请看文章标题 |
## 二级标题 | 以此类推 n 级标题为 n 个 “ # ” | 如本文各个标题所示 |
[链接](网址) | 方括号内容为显示的文本,小括号内容为网址 | 链接 |
 | 方括号内容为图片名称,可省略,如何上传本地图片请看下文 | 暂无 |
\> 引用 | 文本前加一个 > 号,> 后加空格 | 如上文所示 |
* 无序列表 | * + - 都是可以的,并加空格 | · 无序列表 |
1. 有序列表 | 数字+小数点+内容 | 1. 有序列表 |
--- | 水平分割线 | 如上文所示 |
回车 | 换行语句,需要两次回车 | 暂无 |
\**转义字符** | 符号前加 \ ,即可实现转义功能 | \**转义字符** |
`hello word` | 用单引号围住代码,注意是 esc 键下方的引号 | hello world |
- 代码段
```C
int main()
{
printf("hello world\n");
return 0;
}
```
代码段首末端分别用三个 ``` 围住,注意 ` 是 esc 键下方的引号,首行 ``` 后加上程序语言的名称可实现语法高亮。 实际效果
int main()
{
printf("hello world \n");
return 0;
}
- 表格
| 产品型号 | 主 频 | SRAM |
|---|---|---|
| STM32F103C8T6 | 72MHz | 20KB |
| MM32F103C8T6 | 96MHz | 20KB |
第二行不会出现在实际表格中,每串需要用超过3个" - "短横实现,行与行之间不需要空行,效果如下:
产品型号 | 主 频 | SRAM |
---|---|---|
STM32F103C8T6 | 72MHz | 20KB |
MM32F103C8T6 | 96MHz | 20KB |
- 本地图片上传
- 由于 Markdown 语法需要图片的网络地址,所以需要先将本地图片上传至网络,那么,如何上传至网络呢?首先要接触 “图床” 这个概念,一般指存储图像的服务器,我们只需要在百度搜索“图床”两字,选择自己喜欢的网站即可。
- 这里,我以遇见图床为例,很简单,我们只需要将本地图片直接拖拽到窗口内,点击上传,复制下方的地址即可
- 或者干脆直接选择已经生成的 Markdown 代码
下面,我将用 gif图 的方式来演示一下上述情况
- 标题
- 加粗/倾斜

- 链接

- 引用

- 代码

-
以上,就是 Markdown 一些常见的语法了,看到这里,就赶快去实践一下吧,比如改一改以前文章,如果想查看更多语法,可以点击这里,或者直接百度需要的语法。
-
有不足或错误的地方,请留言。