【脚本说明撰写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的用法,++这里使用下划线++

  • 分隔线,三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。

    此处为***分隔线

  • 引用, 使用>>

  • 这是一个一级标题

  • 这是一个二级标题

  • 单行代码 `

  • 这是一个单行的代码

  • 多行代码需要在语句前后使用反引号"```",开头注明语句类型

javascript 复制代码
import pandas as pd
var foo = 'bar';
a='test'
python test.py  --i test --o final
文件-另存为-导出格式,可选多种
  • 安装插件 Markdown PDF
  • 右键


格式示例参考网址

相关推荐
特创数字科技5 小时前
纯本地离线运行的文档脱敏工具(技术分享)
前端·驱动开发·python
东莞市云毅网络有限公司7 小时前
用 Playwright 搭一套问答平台引用监测的最小骨架
python·数据清洗·rag·企业知识库·文档解析
Thanks_ks7 小时前
【第 010 讲】全面掌握 Python 变量与常量:变量的定义与赋值 | 标识符与命名规范 | 变量的底层机制 | 常量与魔术数字
python·内存·变量·标识符·常量·赋值·命名规范
飞Link7 小时前
灵巧手是什么?从机械结构、驱动方式到控制原理,认识机器人的精细操作能力
人工智能·python·机器人
用户0332126663678 小时前
使用 Python 快速查找并高亮 PDF 中的文本
python
用户019027581618 小时前
用 pandas-ta 给 A 股算技术指标(配合 AlphaFeed)
python
2601_967980119 小时前
python+appium自动化测试如何控制App的启动和退出
android·自动化测试·python·appium·设备调试
威哥爱编程10 小时前
模拟面试智能体开发实战 12:每篇都能跑不等于接起来能跑,端到端联调收官把十一块拼图合成一个能用的智能体
python·agent·harmonyos
威哥爱编程10 小时前
模拟面试智能体开发实战 11:报告只躺在后端怎么复盘,把总评搬上手机还要适配大小屏
python·agent·harmonyos
2601_9679873711 小时前
Python 实现行为驱动开发 (BDD) 自动化测试详解
自动化测试·python·bdd·behave·gherkin