markdown编写操作手册

2024-05-03 05:47:20

前提：会markdown基本语法，临时学，很简单。

目录

一、使用markdown编写的操作手册，直接套用模版，so easy!

二、vsCode 下安装markdown插件

三、IDEA下安装markdown插件

四、vsCode下让md生成html

markdown模版下载

一、使用markdown编写的操作手册，直接套用模版，so easy!

1.下载压缩包后，解压；
2.修改.md的内容；
3.复制md内容到https://c.runoob.com/front-end/712 粘贴，点击”显示HTML“；
4.复制生成的html,粘贴到HelpBook.html中的内容部分；
5.在浏览器打开HelpBook.html，即可预览效果；

效果图：

二、vsCode 下安装markdown插件

三、IDEA下安装markdown插件

ps:个人感觉不太好用，不能同时预览而且会发现IDEA变卡了。

shift按两下，找到actions，输入 plugins，如图：

创建一个.md文件即可。

四、vsCode下让md生成html

1.输入插件名： Markdown Preview Enhanced，安装

2.在md文件中右键，点击如下：

3.在preview窗口中，右键，点击HTML(offline)，会生成html文件到md文件所在的目录

4.打开html，右键”查看网页源代码“，找到<div class="mume markdown-preview "> </div>中的内容复制粘贴即可。

markdown编写操作手册相关推荐

如何搭建产品操作手册
对于企业来说,拥有一份完备的产品操作手册无疑是至关重要的.操作手册不仅是新员工学习产品使用及维护的重要参考,也是产品售后服务与客户支持的必备文件.在手册编写上,应清晰明了地介绍产品的功能.配置及故障排 ...
如何编写用户操作手册
1 引言 1.1 编写目的说明编写这份操作手册的目的,指出预期的读者. 1．2 前景说明: a．这份操作手册所描述的软件系统的名称: b．该软件项目的任务提出者.开发者.用户(或首批用户)及安装该 ...
关于编写公司软件测试规范操作手册计划书
1.前言本文档主要描写对该计划的前期阐述,说明其重要性与操作过程的前期计划.着重点描述未来 <本公司软件测试规范操作手册>的深度与可操作性等问题. 2.为什么要编写此规范手册首先从公司 ...
编写用户帮助/操作手册指南
背景: 用户操作手册是一份指导用户使用产品或服务的重要手册. 一个新系统,需要写用户操作手册,该从何下笔?本篇是一篇教你编写用户帮助/操作手册的指南- 首先,先来看一个反例 : 这个是我入职的时候,我 ...
群晖DS920+ NAS操作手册（个人原创编写）
一. NAS基本信息二.访问方式 2.1 通过域名连接 1)在浏览器中输入NAS域名(QC ID或公网域名):quickconnect.cn/XXX. 2)输入账户密码,NAS连接成功. 2.2 通 ...
操作手册的目的、传统的产品操作手册弊端、如何设计优质手册
操作手册是详细描述软件的功能.性能和用户界面,使用户了解到如何使用该软件的说明书.很多时候,当我们对产品的某个功能感到困惑时,往往需要一份操作手册来帮助我们解答疑惑. 何为操作手册,官方的定义如下:操 ...
内容策划：如何编写产品手册？ | 技术写作什么鬼
有朋友询问:如何编写产品手册?公司客户说不会用我们的网站,市场部让我们产品写产品手册,老大让我写,可是我没有写过这个东西,不知道产品手册到底要写什么,求指导. 产品手册,是一个非常典型的市场文档,各行 ...
软件生存周期文档系列之 6.用户操作手册
6 用户操作手册 6.1 引言 6.1.1 编写目的 6.1.2 项目背景 6.1.3 参考资料(包括项目计划任务书.合同或批文:项目开发计划:需求规格说 ...
广数980tc3从u盘复制到系统_广州数控GSK980TC3车床数控系统操作手册（选）
控制轴轴名 3 个基本轴的名称默认是 X. Z. C.用数据参数 P005 设定控制轴数,用 P175-P179 设定每个附加轴的名称,如设为 A. B. C 等轴名. 图 2-2-1 车床的轴线示 ...
GSI-PDP管网勘测综合数据处理软件操作手册
GSI-PDP管网勘测综合数据处理软件操作手册https://flbook.com.cn/c/nx1Sd1lJAo GSI-PDP管网勘测综合数据处理软件是在 Windows7 32 位系统下开发,开 ...

最新文章

热门文章