编写、测试、构建和发布最佳教程操作方法API 参考用户指南SDK 文档

最强大的开发环境 – 现已适合编写文档

开箱即用的文档即代码

文档即代码管道

使用单一创作环境,免除对多种工具的需求。借助内置 Git UI、集成式构建工具、自动化测试以及现成和可自定义的布局,专注于您的内容。

结合 Markdown 和 XML

现在,您可以将 Markdown 与语义标记的优势相结合。选择一种格式,或使用语义特性和元素、Mermaid 图和 LaTeX 数学公式丰富 Markdown。

文档质量自动化

通过编辑器中的超过 100 项即时检查以及实时预览和构建期间的测试确保文档质量和完整性。

实时预览

预览显示的文档与读者将看到的完全相同。在 IDE 中预览单个页面,或在浏览器中打开整个帮助网站而不运行构建。

单一来源

从较小的内容块到整个主题或目录部分,重用一切。灵活使用筛选器和变量。为复杂标记元素使用预定义模板,或者配置您自己的模板。

集中创建 API 和产品文档!

创建用户文档和 API 参考时,不再需要在不同工具之间跳来跳去。 将 API 文档整合到您的帮助网站中,以相同的布局发布,并在自动生成的参考中补充手动编写的内容。

查看运作方式

由文档创作者打造…
为文档创作者服务

此项目在数百次客户访谈和 10 多年 IntelliJ 平台文档工作的基础上开发而成。这些经验给我们带来一长串需要构建的功能和需要解决的问题,我们将逐一处理。

想帮忙吗?立即试用 Writerside,并告诉我们您的想法!

使用 Writerside 构建这样的文档

许多 JetBrains 产品已经在使用我们的文档平台。现在,您可以使用我们所有的知识、经验和模板为您自己的产品构建文档。

常见问题解答

Writerside 现在作为抢先体验计划分发,完全免费。

即使在 Writerside 发布后,我们也会提供免费版本或持续的 EAP 计划,让您可以继续免费使用工具。

Writerside 有两种类型的源文件:Markdown 和 XML,但这并不意味着您必须坚持单一格式。您可以使用 Markdown 编写并注入更复杂的元素,例如语义特性和 XML 元素。两种标记都有完整的编辑器辅助,包括补全和验证。

如果主要源代码库采用 XML 格式,您将能够接受外部贡献者的 Markdown 更改请求,并将 Markdown 转换为 XML。同样,您可以将 Markdown 片段转换为 XML,例如,需要合并表格中单元格的情况。

我们希望 Markdown 和基于 XML 的语义标记的组合能够覆盖大多数用例。但我们也接受反馈,如果您发现缺少其他标记提供的功能,请告诉我们。

您可以在本地存储文件,但建议选项是使用 Git 仓库。我们为所有 Git 操作、管理分支和解决冲突提供了方便的 UI。您还可以使用其他受支持的版本控制系统,例如 Subversion 或 Perforce。

虽然我们相信基于 Web 的文档,但人们有时可能仍然需要生成打印格式。自 2024 年 1 月起,我们支持 PDF 输出

Writerside 允许您在本地构建文档项目并生成 .zip 文件。然后,您需要将其上传到您的网站或托管在 GitHub Pages、Amazon AWS、Netlify 或任何其他托管服务上。我们正在考虑未来提供我们自己的文档托管服务。

如果您使用 CI/CD 服务器,我们可以作为 Docker 容器提供构建器脚本,您可以使用这些脚本配置文档构建。

您可以将 Writerside 配置为生成 Algolia 搜索索引,还可以注册免费的 Algolia 方案。

我们也在开发自己的搜索解决方案。

Writerside 的早期版本提供了一些自定义选项,例如:

  • 更改页眉和页脚的外观。
  • 添加您的徽标和版权。
  • 三种支持浅色和深色主题的颜色预设(柔和、对比度和鲜艳)可供选择。
  • 为高亮显示的元素选择强调色。
  • 将链接嵌入社交媒体和其他资源。

我们计划添加更多选项并使文档自定义更加灵活。

如果您有 Markdown 源,可以将其导入 Writerside 项目。我们还在推进从基于 XML 的格式(包括 DITA)的迁移。

我们会在 Slack 工作区中定期发布更新(请在加入之前阅读我们的行为准则)。您也可以在 YouTrack 中关注我们的项目,并报告问题或提交功能请求。

您也可以订阅我们的简报,了解所有主要产品更新。