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插件就可以查看这个生成的网页了（这个教程网上很多，我就不赘述了）