用户手册书写教程

准备工作

安装vscode

image.png

image.png

任意文件夹即可,创建README.md文件,开始书写markdown。

右上角左侧第一个按钮开启同步预览功能。


image.png

image.png

暂时需要用到的markdown语法

标题

在想要设置为标题的文字前面加#来表示(在#后跟个空格再写文字)
一个#是一级标题,二个#是二级标题,以此类推。支持六级标题。

示例:

# 这是一级标题
## 这是二级标题
### 这是三级标题
#### 这是四级标题
##### 这是五级标题
###### 这是六级标题

效果如下:

这是一级标题

这是二级标题

这是三级标题

这是四级标题

这是五级标题
这是六级标题

图片

语法:

![图片alt](图片地址 ''图片title'')

图片alt就是图片加载中或者加载失败时显示的文字,相当于对图片内容的解释。
图片title是图片的标题,当鼠标移到图片上时显示的内容。title可加可不加,两者最好一样,简单省事儿

示例:


image.png

鼠标移到图片上时出现


image.png
image.png

确保.md文件跟图片文件位于同一文件夹下,按上述写法,即可。


image.png

请注意相关图片的命名!!!例子如上图所示,灰常重要,方便后期的维护!!!有任何随意命名以求效率者,一张图片五块钱请自觉转账到大兄弟的微信收款账号下,谢谢
———《仲贤语录》

注意

所有文件开头处需要加上固定的代码

# 注册和登录

<ClientOnly>
  <CMediumZoom/>
</ClientOnly>

## 注册

其中 注册和登录 替换为相应的顶级标题

一级标题后跟二级标题,以此类推。

如需了解更多语法,参照此处markdown语法

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 关于Markdown 一整个学期下来,我觉得让我收获最大之一的是学会markdown语言。我们平常都是使用Word...
    Dacade阅读 962评论 0 2
  • 欢迎关注微信公众号:北岛向南(id:nanzhouie) GitHub Pages:https://zhouie....
    zhouie阅读 4,910评论 4 72
  • 2017.12.01 星期五 晴 一日之计在于晨 宝妈最近太忙,乐乐前几天表现也不太好,可能是因为感冒原因 状态...
    0向幸福出发0阅读 273评论 0 1
  • 辞职大半年后,积蓄一分不剩的用光了,而这拉伤的韧带损伤还在治疗当中,发现家里的工作相当不好找,然后忍不住的焦躁起来...
    胖脸拉姐阅读 317评论 0 2
  • 文/刘浩 主持人: 各位观众,欢迎大家参与由乐S举办的“中国成语大会”。本次的比赛的参赛选手是原乐S创始人,董事长...
    光印良品阅读 259评论 0 0