又一款在线文档写作神器-Writerside

发布时间:2024年01月23日

背景

最近自己整理一款在线文档,不小心,又发现github上有一款很比较符合我想法的文档,仔细跟踪以下,这款工具是 Writerside,竟然是jetbrains 出品,可以单独下载,也可以使用idea的插件使用,当然使用插件模式。

特点

官网上有各种优点介绍,比如

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

是的,超级强大,不过我更关心的是

  1. 左边的树可以n级扩展,目前看树不够美观,不过好像有主题市场
  2. 右边的展现md格式,可以有大纲
  3. 可以在github等多个云服务上一键部署
  4. 全文搜索也做了集成考虑,当然还有很多,不展开。

使用

  1. idea安装插件
  2. 开始使用
  3. 不懂请看官网文档, Writerside - IntelliJ IDEs Plugin | Marketplace

文章来源:https://blog.csdn.net/wildhorseli/article/details/135777827
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。