【脚本说明撰写markdown】如何基于VScode 撰写使用说明文档，及格式转换.md、.html、.pdf格式
如何基于VScode 撰写使用说明文档，及格式转换.md、.html、.pdf格式
下载插件
下载markdown
-
进入vscode后，进入扩展工具（快捷键ctrl+shift+X），搜索markdown，选择markdown All in One并安装
-
安装Markdown Preview Enhanced,是一种主题.
打开右边预览,如图,可以直接观察到预览结果,Markdown 还没有办法指定图片的高度与宽度。
- 可以查看大纲：左侧栏-资源管理器-根据级别显示
编写md文件，其中文件内容格式如下
-
使用“#” 即可设置标题，可涉及一级标题#，二级标题##
-
粗体**， 这里使用粗体
-
斜体* ，这里使用斜体
-
粗体加斜体***， 这里使用粗斜体
-
删除~~ ，
这里字体删除 -
下划线可以借鉴html的用法，这里使用下划线
-
分隔线,三个以上的星号、减号、底线来建立一个分隔线，行内不能有其他东西。
此处为***分隔线 -
引用, 使用>>
-
这是一个一级标题
-
这是一个二级标题
-
单行代码 `
-
这是一个单行的代码 -
多行代码需要在语句前后使用反引号“```”，开头注明语句类型
import pandas as pd
var foo = 'bar';
a='test'
python test.py --i test --o final
-
网页链接：语法格式为链接名称
参考下载拓展插件步骤
使用VSCode书写Markdown代码及Markdown语法介绍 -
或者直接也可以直接用尖括号括起链接
https://blog.csdn.net/pxyp123/article/details/124331401 -
高级链接，变量来设置一个链接，变量赋值在文档末尾进行,图片也可以。示例如下：
参考网站 -
高级插入图片
参考图片
文件-另存为-导出格式，可选多种
- 安装插件 Markdown PDF
- 右键
格式示例参考网址