Znai：构建功能强大、可维护、美观的用户指南

Znai：构建功能强大、可维护、美观的用户指南

znai Build functional, maintainable, beautiful User Guides with markdown and Znai plugins. Instant pages navigation. Local search. Multiple integrations to work with Python, Java, C++, OpenAPI, etc. Transform "getting started" sections into slideshow for your workshops. Manage multiple documentations with self-deployed znai hub. 项目地址: https://gitcode.com/gh_mirrors/zn/znai

Znai 是一个开源项目，致力于帮助开发者构建功能强大、可维护且美观的用户指南。该项目主要使用 Java、JavaScript、Groovy 和 TypeScript 等编程语言。

项目的核心功能

Znai 提供了以下核心功能：

1. Markdown 与自定义扩展：支持使用 Markdown 编写文档，并提供了自定义扩展和数十种插件。
2. 外部文件内容支持：可以从外部文件中提取内容，并支持标记和过滤器。
3. API 文档生成：支持生成美观的 API 文档，并提供了两种页面布局选项，方便展示示例和相关信息。
4. 即时页面导航：提供了方便的即时页面导航功能。
5. 本地搜索：支持快速的本地搜索，并提供了搜索结果预览。
6. 多种语言集成：支持与 Python、Java、OpenAPI 等语言的集成。
7. 幻灯片模式：可以将文档内容自动转换为幻灯片，无需额外配置。
8. 暗/亮主题切换：支持在运行时切换暗/亮主题。
9. 自动化测试结果集成：可以利用自动化测试结果丰富文档，包括注释图像、REST 响应、CLI 输出等。
10. GitHub Pages 友好：支持在 GitHub Pages 上部署。
11. 外部资源嵌入：在构建时支持嵌入外部资源。

项目最近更新的功能

最近更新中，Znai 项目包含了以下新功能和改进：

1. 预览模式增强：增强了预览模式，现在可以自动监听本地文件的更改，并自动导航到更改的页面，高亮显示更改内容。
2. 文档中心：提供了免费的、开源的企业支持，可以单站点托管多个文档，自动检测构建输出中的文档并更新托管文档。
3. 性能优化：对项目的性能进行了优化，提高了文档构建和搜索的速度。

Znai 项目持续更新，致力于为开发者提供更好的文档构建体验。

znai Build functional, maintainable, beautiful User Guides with markdown and Znai plugins. Instant pages navigation. Local search. Multiple integrations to work with Python, Java, C++, OpenAPI, etc. Transform "getting started" sections into slideshow for your workshops. Manage multiple documentations with self-deployed znai hub. 项目地址: https://gitcode.com/gh_mirrors/zn/znai