Writerside生成在线帮助文档或用户手册软件基础使用教程

Writerside是JetBrains出的一个技术文档工具,既能用在JetBrains IDE上,也能单独用。它能帮你轻松写、建、测、发技术文档,像产品说明、API参考、开发指南等都能搞定。

特点:

  1. 文档即代码:它让你像管代码一样管文档,有Git UI和集成构建工具。
  2. Markdown和XML一起用:在Writerside里,Markdown和XML都能用,还能加语义属性或元素,Markdown也能轻松转XML。
  3. 文档质量检查:它能自动检查100多项内容,比如断链、丢资源等,保证文档没问题。
  4. 实时预览:你写的时候,它就能预览最后效果,不用等构建完。
  5. 内容重用:维护一个内容源,就能重复使用内容块、主题等,提高效率。
  6. API文档生成:写用户文档和API参考超方便,不用换来换去。
  7. 多语言:它支持25种以上语言,包括英语、德语等,还有拼写和语法检查。

安装与启动

需要科学上网,资源也无法上传至CSDN,需要的可以评论留邮箱,注明版本需求(Windows、Windows Arm64、Linux、MacOS)
EAP版本是免费公测版,后续要不要收费暂不清楚,感觉是要的,所以注意不要和平台绑定太死,它是XML和MD都支持
尽量选择使用MD语法,后面就算不用了,到时候迁移起来也不会那么费劲

  1. 下载安装程序Writerside,并运行安装
  2. 安装完成后,启动Writerside软件。
  3. 切换成中文界面
    在这里插入图片描述
  4. 切换界面风格,看自己的习惯切换,因为用惯了各种开发工具,因此还挺喜欢经典UI模式的,但是新版UI的中文支持度更好…
    在这里插入图片描述
    经典UI,传统工具类软件风格
    在这里插入图片描述新UI:很有互联网当下的简约设计感,什么都收起来…
    在这里插入图片描述

创建新项目

  1. 在主菜单中选择文件-新建/New Project

  2. 在弹出向导中,设置存储位置
    在这里插入图片描述

  3. 创建工程,新手可以创建更多的模板工程,学一学里面提供的语法规则

创建和编辑内容

如下所示,就是创建好一个工程了。在这里插入图片描述

  1. 添加新主题
    在这里插入图片描述
    在这里插入图片描述

  2. 推荐创建MD格式文件,除了文本性描述内容,如果要插入图片或者视频,直接在文本编辑区域复制粘贴,它会自动识别帮你写好语法,多试一试就熟悉了,还是很方便的

发布

新版在对应这个位置也有一个这样的图标

注意这就是打包,不是文件里面的导出
Web Archive是将当前工程直接打包成可发布的Html包
PDF顾名思义就是直接生成一份离线手册,这个暂时还无法应对过于复杂的手册,视频什么的会完全丢失,连截图都没有
在这里插入图片描述

  1. 点击导出按钮

  2. 设置界面,暂时不熟悉就不用管,直接运行输出就好
    在这里插入图片描述

  3. 下方界面会弹出一串输出
    在这里插入图片描述
    在这里插入图片描述

  4. 点击Zip就可以跳转到输出目录,解压就是一个完整的Html离线包
    在这里插入图片描述

  5. 解压后,使用VsCode打开文件夹,通过liveshare插件就可以查看这个生成的网页了(这个教程网上很多,我就不赘述了)

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/bicheng/21201.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

【大数据Spark】常见面试题(万字!建议收藏)

文章目录 入门级中等难度中高级难度数据倾斜解决方法 入门级 什么是Apache Spark?它与传统的MapReduce有何不同? Apache Spark是一个开源的分布式计算系统,它提供了高效的数据处理和分析能力。与传统的MapReduce相比,Spark具有更快…

海光CPU:国产信创的“芯“动力解读

国产信创CPU-海光CPU CPU:信创根基,国之重器 国产CPU形成三大阵营:自主架构、x86及ARM。自主阵营中,龙芯和申威以LoongArch和SW-64为基石;ARM阵营由鲲鹏、飞腾主导,依托ARM授权研发处理器;x86阵…

红帽练习 之逻辑卷 pv lv gv

逻辑卷习题 1 在/dev/sdb 存储设备上创建物理设备分区 创建2个大小各为256MB的分区 并设置为linux lvm类型 使用first 和second 作为这些分区的名称 parted /dev/sdb mklabel gpt parted /dev/sdb primary mkpart first 1M 256M parted /dev/sdb set 1 …

【Linux|数据恢复】extundelete和ext4magic数据恢复工具使用

环境:Centos7.6_x86 一、extundelete工具 1、extundelete介绍 Extundelete 是一个数据恢复工具,用于从 ext3 或 ext4 分区中恢复删除文件。根据官网0.2.4版本介绍是支持ext4,但实际上使用发现ext4格式有些问题,会报以下错误&…

动态SQL IF语句

IF语句学习 第一种写法(标准) 我们先来看以下标准写法: select * from .. <where> <if test""> and ....... <if test""> and ....... <where> 我们用了一个where标签 , 内嵌if语句 第二种写法: 这是第二种写法:不用where标…

大降分!重邮计算机专硕复试线大降50分!重庆邮电计算机考研考情分析!

重庆邮电大学&#xff08;Chongqing University of Posts and Telecommunications&#xff09;简称重邮&#xff0c;坐落于中国重庆市主城区南山风景区内&#xff0c;是中华人民共和国工业和信息化部与重庆市人民政府共建的教学研究型大学&#xff0c;入选国家“中西部高校基础…

一篇文章搞懂Go语言切片底层原理(图文并茂+举例讲解)

1. 切片和数组的底层关系 Go语言切片的数据结构是一个结构体&#xff1a; type slice struct {array unsafe.Pointerlen intcap int }Go语言中切片的内部结构包含地址、大小和容量。将数组比喻成一个蛋糕&#xff0c;那么切片就是需要切的那一块&#xff0c;而那一块的的…

c++学生管理系统

想要实现的功能 1&#xff0c;可以增加学生的信息&#xff0c;包括&#xff08;姓名&#xff0c;学号,c成绩&#xff0c;高数成绩&#xff0c;英语成绩&#xff09; 2&#xff0c;可以删除学生信息 3&#xff0c;修改学生信息 4&#xff0c;显示所有学生信息 5&#xff0c…

支持AMD GPU的llm.c

anthonix/llm.c: LLM training in simple, raw C/HIP for AMD GPUs (github.com) llm.c for AMD devices This is a fork of Andrej Karpathys llm.c with support for AMD devices. 性能 在单个7900 XTX显卡上使用默认设置&#xff0c;目前的训练步骤耗时约为79毫秒&#x…

Docker的安装、启动和配置镜像加速

前言&#xff1a; Docker 分为 CE 和 EE 两大版本。CE 即社区版&#xff08;免费&#xff0c;支持周期 7 个月&#xff09;&#xff0c;EE 即企业版&#xff0c;强调安全&#xff0c;付费使用&#xff0c;支持周期 24 个月。 而企业部署一般都是采用Linux操作系统&#xff0c;而…

【软件设计师】2022年上半年真题解析

​​冯诺依曼计算机体系结构的基本特点是&#xff1a; A. 程序指令和数据都采用二进制表示 - 这是正确的&#xff0c;因为冯诺依曼架构下的计算机使用二进制形式来表示和处理所有信息&#xff0c;包括指令和数据。 B. 程序指令总是存储在主存中&#xff0c;而数据则存储在高速…

Java基础语法详解——入门学习教程

Java 基础 目录 一、数据类型 基本类型包装类型缓存池 二、String 概览不可变的好处String, StringBuffer and StringBuilder String Poolnew String(“abc”) 三、运算 参数传递float 与 double隐式类型转换switch 四、关键字 finalstatic 五、Object 通用方法 概览equals()ha…

深入解析 MongoDB Map-Reduce:强大数据聚合与分析的利器

Map-Reduce 是一种用于处理和生成大数据集的方法&#xff0c;MongoDB 支持 Map-Reduce 操作以执行复杂的数据聚合任务。Map-Reduce 操作由两个阶段组成&#xff1a;Map 阶段和 Reduce 阶段。 基本语法 在 MongoDB 中&#xff0c;可以使用 db.collection.mapReduce() 方法执行…

IsoBench:多模态基础模型性能的基准测试与优化

随着多模态基础模型的快速发展&#xff0c;如何准确评估这些模型在不同输入模态下的性能成为了一个重要课题。本文提出了IsoBench&#xff0c;一个基准数据集&#xff0c;旨在通过提供多种同构&#xff08;isomorphic&#xff09;表示形式的问题&#xff0c;来测试和评估多模态…

算法(十三)回溯算法---N皇后问题

文章目录 算法概念经典例子 - N皇后问题什么是N皇后问题&#xff1f;实现思路 算法概念 回溯算法是类似枚举的深度优先搜索尝试过程&#xff0c;主要是再搜索尝试中寻找问题的解&#xff0c;当发生不满足求解条件时&#xff0c;就会”回溯“返回&#xff08;也就是递归返回&am…

enum4linux一键查询SMB信息(KALI工具系列十六)

目录 1、KALI LINUX简介 2、enum4linux工具简介 3、在KALI中使用enum4linux 3.1 目标主机IP&#xff08;win&#xff09; ​编辑 3.2 KALI的IP 4、操作示例 4.1 运行工具 4.2 列出用户名 4.3 提取用户名 4.4 使用自定义RID范围 4.5 列出组 4.6 列出共享文件夹 4.7…

【笔记小记】掌握市场脉动:全营销解决方案的力量

前面虽然说了这个模型&#xff0c;而且是分章说的&#xff0c;那么在此以笔记小记的形式再说一下&#xff0c;企业面临的挑战与日俱增&#xff0c;消费者需求的多样化、技术的不断进步、全球化的深入以及社会责任的日益重要&#xff0c;这些因素共同塑造了市场的现状和未来&…

网络监听技术

网络监听技术 网络监听概述网络监听环境 流量劫持网络环境共享式网络监听原理交换式网络监听交换机的工作方式交换网络监听&#xff1a;交换机集线器交换网络监听&#xff1a;端口镜像交换网络监听&#xff1a;MAC洪泛交换网络监听&#xff1a;MAC洪泛交换网络监听&#xff1a;…

【Unix】消息类的格式与使用

本文给出一个MacOS操作系统中的消息类的使用过程示例&#xff08;结合gencat命令&#xff0c;<nl_types.h>头文件以及catopen,catgets,catclose3个函数&#xff09; 首先根据对应的操作系统&#xff0c;查看gencat命令 man gencat 可以详细看到其中对于输入文件&#x…

Typescript高级: 深入理解extends keyof语法

概述 在TypeScript中&#xff0c;extends关键字是类型系统中一个极其重要的组成部分它不仅用于类的继承&#xff0c;也是类型兼容性检查和泛型约束的关键机制特别是当它与keyof关键字结合&#xff0c;形成K extends keyof T的结构时它为类型系统带来了强大的灵活性和表达能力&…