JetBrain WriteSide有什么优势？

最新推荐文章于 2024-09-27 18:30:31 发布

fK0pS

最新推荐文章于 2024-09-27 18:30:31 发布

阅读量594

点赞数 7

文章标签：经验分享

本文链接：https://blog.csdn.net/Hodors/article/details/135092208

版权

JetBrainsWriteSide是一款强大的文档生成工具，它结合Markdown和XML，提供文档即代码管道、实时预览、质量自动化检查等功能，支持RESTAPI文档生成，实现单一源管理，简化项目文档编写和维护过程。

摘要由CSDN通过智能技术生成

JetBrain WriteSide有什么优势？

https://www.jetbrains.com/zh-cn/writerside/

https://zhuanlan.zhihu.com/p/662270037

主要是用来生成项目文档的？

这个东西到底有啥用啊，完全get不到啊；

宣传语是：

 Use it to author, build, test, and publish technical documentation.

Why we need to use WriterSide

WriterSide有什么优势？

https://blog.csdn.net/m0_63748493/article/details/133985074

功能

文档即代码管道：使用单一创作环境，免除对多种工具的需求。借助内置 Git UI、集成式构建工具、自动化测试以及现成和可自定义的布局，专注于您的内容
结合 Markdown 和 XML：现在，您可以将 Markdown 与语义标记的优势相结合。选择一种格式，或使用语义特性和元素、Mermaid 图和 LaTeX 数学公式丰富 Markdown
文档质量自动化：通过编辑器中的超过 100 项即时检查以及实时预览和构建期间的测试确保文档质量和完整性
实时预览：预览显示的文档与读者将看到的完全相同。在 IDE 中预览单个页面，或在浏览器中打开整个帮助网站而不运行构建
单一来源：从较小的内容块到整个主题或目录部分，重用一切。灵活使用筛选器和变量。为复杂标记元素使用预定义模板，或者配置您自己的模板
REST API 文档生成：创建用户文档和 API 参考时无需在不同工具之间跳转。现在，您可以将 API 文档合并到帮助网站中，以相同的布局发布，并通过手动编写的内容补充自动生成的参考

结论；