add compare with other tools

zizdlp · Sep 1, 2024 · b733e0c · b733e0c
1 parent 248b3e3
commit b733e0c
Show file tree

Hide file tree

Showing 3 changed files with 89 additions and 4 deletions.
diff --git a/Features/Core Features.md b/Features/Core Features.md
@@ -1,9 +1,41 @@
 # Core Features
 
-ZBook supports multi-user management, allowing users with different roles to perform operations based on their permissions. Each user can independently create or manage their own repositories, edit personal information, view access analytics, and link third-party accounts (such as GitHub, GitLab, etc.). Administrators can assign different permission levels to ensure secure access and management of the website's core functions. The multi-user functionality is designed to be flexible, suitable for individual developers, team collaborations, and large organizations, providing an efficient management experience.
+ZBook supports multi-user management, allowing users with different roles to perform operations based on their permissions. Each user can independently create or manage their own repositories, edit personal information, view access analytics, and link third-party accounts (such as GitHub, GitLab, etc.). Administrators can assign different permission levels to ensure secure access and manage the core functions of the site. The flexible multi-user functionality is suitable for individual developers, team collaboration, and large organizations, providing an efficient management experience for users.
 
-![Multi-user](./assets/多用户.png)
+![Multi-User](./assets/多用户.png)
 
-ZBook supports streamlined Markdown repository rendering with various theme styles, colors, and multi-language support, including night mode. It also features full-text search in multiple languages.
+ZBook offers simple Markdown repository rendering, supports various theme styles, colors, multi-language support, night mode, and full-text search in multiple languages.
 
-![Doc](./assets/doc.png)
+![doc](./assets/doc.png)
+
+## Comparison
+
+Below is a comparison table between ZBook, MkDocs, and other similar platforms (such as GitBook and Docusaurus) to help you understand the features and differences of each platform:
+
+| Feature/Platform           | ZBook                                          | MkDocs                             | GitBook                          | Docusaurus                       |
+| -------------------------- | ---------------------------------------------- | ---------------------------------- | -------------------------------- | -------------------------------- |
+| **Open Source**            | Yes                                            | Yes                                | No (Core features free)          | Yes                              |
+| **Self-Hosted**            | Yes                                            | Yes                                | No                               | Yes                              |
+| **Free to Use**            | Yes                                            | Yes                                | Core features free               | Yes                              |
+| **Multi-User Support**     | Yes                                            | No                                 | Yes (Paid users only)            | No                               |
+| **Permission Management**  | Yes                                            | No                                 | Yes (Paid users only)            | No                               |
+| **Multi-Language Support** | Yes                                            | Yes                                | No                               | Yes                              |
+| **Plugin Extensions**      | Yes                                            | Yes                                | No                               | Yes                              |
+| **Markdown Support**       | Yes                                            | Yes                                | Yes                              | Yes                              |
+| **Search Functionality**   | Yes                                            | Yes (Built-in)                     | Yes                              | Yes                              |
+| **Theme Customization**    | Yes                                            | Yes                                | No (Limited in paid version)     | Yes                              |
+| **Comment System**         | Yes                                            | No                                 | No                               | No                               |
+| **Sync Support**           | Yes (Manual & Automatic)                       | Yes (Manual)                       | Yes (Git integration)            | Yes (Git integration)            |
+| **Version Control**        | Yes                                            | Yes                                | Yes                              | Yes                              |
+| **Integration**            | GitHub, GitLab, etc.                           | GitHub, GitLab                     | GitHub                           | GitHub, GitLab                   |
+| **Community Support**      | No                                             | Active                             | Active                           | Active                           |
+| **Visitor Analytics**      | Yes                                            | No                                 | No                               | No                               |
+| **Deployment Complexity**  | Low                                            | Low                                | Low                              | Medium                           |
+| **Suitable Scenarios**     | Multi-user, Permission Management, Self-hosted | Lightweight documentation projects | Small teams, individual projects | Large projects, community-driven |
+
+### **Summary**
+
+- **ZBook**: Ideal for projects requiring self-hosting, permission management, and multi-user support, especially suitable for development teams and enterprises.
+- **MkDocs**: Lightweight and easy to use, suitable for individuals or small projects, focused on quick document generation.
+- **GitBook**: Suitable for small teams needing easy onboarding and hosted services, but advanced features require payment.
+- **Docusaurus**: A powerful documentation platform, ideal for large community projects with excellent plugin and theme extension capabilities.
diff --git a/zbook.json b/zbook.json
@@ -257,6 +257,25 @@
             "sublayouts": null
           }
         ]
+      },
+      {
+        "title": "案例",
+        "relative_path": "Cases",
+        "isdir": true,
+        "sublayouts": [
+          {
+            "title": "What Is YOLO Algorithm?",
+            "relative_path": "Cases/YOLO",
+            "isdir": false,
+            "sublayouts": null
+          },
+          {
+            "title": "Memory Safety",
+            "relative_path": "Cases/Memory Safety",
+            "isdir": false,
+            "sublayouts": null
+          }
+        ]
       }
     ]
   },

diff --git a/功能/基础功能.md b/功能/基础功能.md
@@ -7,3 +7,37 @@ ZBook 支持多用户管理，允许不同角色的用户根据其权限进行
 ZBook 支持简洁的 Markdown 仓库渲染，支持多种主题风格，颜色，支持多语言、夜间模式等。与此同时，支持多语言的全文检索。
 
 ![doc](./assets/doc.png)
+
+## 对比
+
+下面是一个将 ZBook 与 MkDocs 及其他类似平台（如 GitBook 和 Docusaurus）进行对比的表格，帮助你了解各平台的特点和区别：
+
+| 特性/平台         | ZBook                  | MkDocs         | GitBook              | Docusaurus         |
+| ----------------- | ---------------------- | -------------- | -------------------- | ------------------ |
+| **开源**          | 是                     | 是             | 否（核心功能免费）   | 是                 |
+| **自托管**        | 是                     | 是             | 否                   | 是                 |
+| **免费使用**      | 是                     | 是             | 核心功能免费         | 是                 |
+| **多用户管理**    | 是                     | 否             | 是（仅付费用户）     | 否                 |
+| **权限管理**      | 是                     | 否             | 是（仅付费用户）     | 否                 |
+| **支持多语言**    | 是                     | 是             | 否                   | 是                 |
+| **插件扩展**      | 是                     | 是             | 否                   | 是                 |
+| **Markdown 支持** | 是                     | 是             | 是                   | 是                 |
+| **搜索功能**      | 是                     | 是（内置）     | 是                   | 是                 |
+| **主题自定义**    | 是                     | 是             | 否（付费版本有限制） | 是                 |
+| **评论系统**      | 是                     | 否             | 否                   | 否                 |
+| **同步支持**      | 是（手动与自动同步）   | 是（手动同步） | 是（Git 集成）       | 是（Git 集成）     |
+| **版本控制**      | 是                     | 是             | 是                   | 是                 |
+| **集成**          | GitHub, GitLab, etc.   | GitHub, GitLab | GitHub               | GitHub, GitLab     |
+| **社区支持**      | 否                     | 活跃           | 活跃                 | 活跃               |
+| **访客数据分析**  | 是                     | 否             | 否                   | 否                 |
+| **部署复杂度**    | 低                     | 低             | 低                   | 中等               |
+| **适用场景**      | 多用户、多权限、自托管 | 轻量级文档项目 | 小型团队、个人项目   | 大型项目，社区驱动 |
+
+### **简要说明**
+
+- **ZBook**: 适合需要自托管、权限管理和多用户支持的项目，特别适用于开发团队和企业使用。
+- **MkDocs**: 轻量级且易于使用，适合个人或小型项目，侧重于文档的快速生成。
+- **GitBook**: 适合需要简单上手和托管服务的小型团队，但高级功能需要付费。
+- **Docusaurus**: 强大的文档平台，适合大型社区项目，具有优秀的插件和主题扩展能力。
+
+通过这个对比，你可以根据项目的具体需求选择合适的平台。