WriterSide
为何JetBrains Writerside是技术文档编写者的最佳选择？
https://gitee.com/numerocode/picgo/raw/master/%E5%BE%AE%E4%BF%A1%E6%88%AA%E5%9B%BE_20250718142039.png
核心功能介绍
1. 集成开发环境：Writerside 可以作为独立的工具使用，也可以作为 JetBrains IDE（如 IntelliJ IDEA、PyCharm 等）的插件使用，使得开发者可以在熟悉的开发环境中直接编写和管理文档。 2. 支持 Markdown 和 XML：Writerside 支持 Markdown 和基于 XML 的语义标记，允许用户结合这两种格式来丰富文档内容，例如在 Markdown 中注入语义属性和元素。
3. 文档质量自动化：内置超过 100 项即时检查，包括测试断开的链接、缺少的资源、不正确的属性值等，确保文档的质量和完整性。
4. 实时预览：提供实时预览功能，显示的文档与读者将看到的完全相同，无需等待构建即可在 IDE 中预览单个页面，或在浏览器中打开整个帮助网站。
5. 单一来源：支持从较小的内容块到整个主题或目录部分的重用，灵活使用筛选器和变量，为复杂标记元素使用预定义模板或配置自己的模板。
所有功能
1. 所见即所得（WYSIWYG）
Writerside 是一款功能强大的所见即所得（WYSIWYG）编辑器，它提供了丰富的格式选项，包括字体、字号、颜色、对齐方式等，让你可以轻松地创建精美的文档。
2. 实时预览
Writerside 支持实时预览，这意味着你可以在编写文档的同时，实时查看文档的效果，从而避免了格式错误或内容丢失的风险。
3. 支持 Markdown
Writerside 支持 Markdown 语法，这意味着你可以直接在编辑器中编写 Markdown 文档，而无需切换到其他编辑器。
4. 支持 LaTeX
Writerside 支持 LaTeX 语法，这意味着你可以在文档中插入数学公式，从而提高文档的可读性和美观性。
5. 支持图片和链接
Writerside 支持插入图片和链接，这使得文档更加丰富和易于使用。
6. 支持表格
Writerside 支持插入表格，这使得文档更加清晰和易于阅读。
7. 支持大纲
Writerside 支持插入大纲，这使得文档更加清晰和易于阅读。
8. 支持代码块
Writerside 支持插入代码块，这使得文档更加清晰和易于阅读。
9. 支持插件
Writerside 支持插件，这使得你可以根据自己的需求安装插件，从而提高文档的功能和效率。
10. 支持导出
Writerside 支持导出，这使得你可以将文档导出为多种格式，从而方便你分享和打印文档。
11. 支持同步
Writerside 支持同步，这使得你可以将文档同步到云端，从而方便你随时随地访问文档。
12. 支持导入
Writerside 支持导入，这使得你可以将文档导入到编辑器中，从而方便你编辑文档。
13. 支持主题
Writerside 支持主题，这使得你可以根据自己的需求选择主题，从而提高文档的可读性和美观性。
14. 支持快捷键
Writerside 支持快捷键，这使得你可以根据自己的需求设置快捷键，从而提高文档的效率。
15. 支持自定义
Writerside 支持自定义，这使得你可以根据自己的需求自定义编辑器，从而提高文档的功能和效率。
16. 支持云端同步
Writerside 支持云端同步，这使得你可以将文档同步到云端，从而方便你随时随地访问文档。
17. 支持离线使用
Writerside 支持离线使用，这使得你可以在没有网络的情况下使用编辑器，从而提高文档的效率。
安装与环境配置
插件方式比较简单，就是在 IDE 中下载安装插件即可。 
使用篇
创建项目
Writerside中，项目是管理文档的基础单元，通过项目可以组织多个文档、子文档和文件夹。
1. 创建新项目：打开Writerside，点击“新建项目”按钮，选择项目的存储路径，填写项目名称和描述信息。 2. 项目结构介绍： 创建项目后，页面会显示项目的整体结构。项目结构包括文档的层次关系、各类子文档和附件。通过项目结构，可以清晰地管理和定位每个文档的位置。
创建Markdown文档
在Writerside中创建文档，可以选择Markdown格式。Markdown是一种轻量级标记语言，便于内容格式化和快速编辑。
创建子文档 在创建的Markdown文件中，可以创建多个子文档以构成更复杂的文档结构。子文档适用于内容层次清晰的文档，例如教程、手册和报告。
文档预览效果
支持的页面语法
Tab标签的使用 Tab标签在Writerside中用于展示不同内容的切换效果，适用于多个内容并行展示的场景。
提示词的使用 提示词用于在文档中插入特别提醒，或标注重点信息。Writerside提供了多种提示词样式（如警告、信息、成功等）便于信息传达。
文章目录功能
Writerside自动生成文章目录，有助于读者快速浏览内容结构，定位具体信息。 
导出文档
