时间:2023-11-07
标签:
JetBrains Writerside是一款功能强大,专业实用的优秀文档撰写软件,软件允许开发人员和编写人员在产品文档、API 参考、开发人员指南、教程和操作方法方面进行协作;基于人工智能的拼写检查和语法纠正工具支持超过 25 种语言。
文档即代码管道,使用单一创作环境,免除对多种工具的需求。借助内置 Git UI、集成式构建工具、自动化测试以及现成和可自定义的布局,专注于您的内容。
结合 Markdown 和 XML,现在,您可以将 Markdown 与语义标记的优势相结合。选择一种格式,或使用语义特性和元素、Mermaid 图和 LaTeX 数学公式丰富 Markdown。
文档质量自动化,通过编辑器中的超过 100 项即时检查以及实时预览和构建期间的测试确保文档质量和完整性。
实时预览,预览显示的文档与读者将看到的完全相同。在 IDE 中预览单个页面,或在浏览器中打开整个帮助网站而不运行构建。
单一来源,从较小的内容块到整个主题或目录部分,重用一切。灵活使用筛选器和变量。为复杂标记元素使用预定义模板,或者配置您自己的模板。
REST API 文档生成,创建用户文档和 API 参考时无需在不同工具之间跳转。现在,您可以将 API 文档合并到帮助网站中,以相同的布局发布,并通过手动编写的内容补充自动生成的参考。
【创建文档】
在IDEA中打开在工具窗口,打开之后有引导页,点击Add documentation按钮,然后点击 To Current Project,选择 New,然后我们添加实例名称(类似文档目录名称),之后生成即可,然后会自动生成帮助实例文档
【创建主题】
有了带帮助实例的文档项目之后,就可以右键目录向其中添加主题并开始编写内容,目前有5种 Markdown 主题和5种 XML 主题。
新建MD格式主题,并在其下面新建两个二级主题,左侧编写,右侧预览效果,并且可以通过拖动更改主题的层次结构。
【构建网站】
在工具窗口中上方有个按钮,单击”Open in Browser“或“Save as ZIP Archive”
直接本地打开网站选”Open in Browser“,文档无报错即可在浏览器中浏览文档了
如果需要发布可以选择“Save as ZIP Archive”生成压缩文件,再部署到服务器中访问
【Nginx 部署】
将上面的压缩包解压到服务器的目录/usr/share/nginx/writer side 中,下面是我的 nginx.conf 配置,大家可以酌情参考
加载全部内容
cursor中文版下载免费 170.18 MB218人在玩 Cursor中文版是一款AI驱动的编程IDE,支持中文设置,提供智能代码补全、错误检测、自动生成代
下载
CudaText(代码文本编辑器)下载 14.82 MB156人在玩 CudaText 是一款轻量高效的代码文本编辑器,内置 160 多种语法高亮,支持小地图、多插入符、代
下载
vscode最新版 119.6 MB111人在玩 VS Code 中文最新版是一款跨平台轻量级代码编辑器,支持多语言开发、插件扩展、智能补全与
下载
dwin dgus电脑版下载 124.52 MB80人在玩 Dwin DGUS 电脑版是一款专业的 DGUS 屏开发配置工具,集成工程管理、字库生成、图片转换与调试
下载