0
点赞
收藏
分享

微信扫一扫

JetBrains文档写作工具--Writerside

夹胡碰 2024-06-14 阅读 9

相信大家多多少少的应该都用过JetBrains公司旗下的产品进行开发,那么你也一定看过它们的官方文档,一进入官方文档的页面就感觉UI是那么的炫酷,跟国内的大不一样,那么它们的文档写作其实也是人家自研的一个工具进行辅助编写的,它就是Writerside。

image.png

官网给的简短的介绍语:开箱即用的文档即代码。

文档即代码管道

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

结合 Markdown 和 XML

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

文档质量自动化

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

实时预览

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

单一来源

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

REST API 文档生成

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

image.png

我自己也是使用Writerside编写的JetBrains插件Comma的用户文档,就我个人使用情况而言,这款工具的体验还是比较不错的,至少目前我使用过的编写文档的工具例如VuePress、VitePress以及Docsify等等,这款工具的体验还是要优于其他几款的,虽然只是EAP版本,但是功能以及UI设计还是挺不错的,反正我是很喜欢这种简单又好看的文档。

举报

相关推荐

0 条评论