// [ 文档搜索引擎优化 ]
{
    " 描述 ": "VoloDocs 通过 GitHub 集成简化文档创建流程，支持 Markdown 格式、版本控制及跨平台协作编辑 "
}

VoloDocs 文档系统

产品概述

VoloDocs 是一款跨平台 Web 应用程序，可帮助您轻松创建精美的技术文档并构建开发者社区。通过深度集成 GitHub 功能，它极大简化了软件文档管理流程。您可以借助 GitHub 实现文档版本控制与托管，并允许用户直接参与文档编辑。

核心功能

直接从 GitHub 仓库获取文档内容
支持 Markdown/HTML 文档格式
版本控制（与 GitHub 发布版集成）
多项目管理支持
支持用户通过 GitHub 编辑文档
跨平台部署（ Windows/Linux/macOS ）

GitHub 仓库

本项目为免费开源项目，您可通过以下地址浏览源代码并参与贡献：

https://github.com/abpframework/abp/tree/master/modules/docs

下载安装

通过以下链接获取 VoloDocs 发行版：

https://apps.abp.io/VoloDocs/VoloDocs.win-x64.zip - Windows 64 位版

https://apps.abp.io/VoloDocs/VoloDocs.win-x86.zip - Windows 32 位版

https://apps.abp.io/VoloDocs/VoloDocs.osx-x64.zip - macOS 版

https://apps.abp.io/VoloDocs/VoloDocs.linux-x64.zip - Linux 版

所有安装包均为自包含部署版本，已内置所需第三方依赖项及 .NET Core 运行时，无需额外安装 .NET Core SDK / 运行时环境。

目录结构

解压 VoloDocs.*.zip 文件后，您将看到 Web 和 Migrator 两个目录。 Web 目录包含网站文件， Migrator 包含数据库迁移工具。在发布网站前，需要创建新数据库或更新现有数据库至最新版本。首次安装时， Migrator 将自动创建数据库，否则执行版本升级。唯一需要配置的是 appsettings.json 文件中的 ConnectionString 连接字符串。具体配置方法请参阅下一章节。

分步部署指南

数据库迁移

进入 VoloDocs 目录下的 Migrator 文件夹，使用文本编辑器打开 appsettings.json ，设置数据库连接字符串。如需查询数据库连接字符串格式，请访问： https://www.connectionstrings.com/

设置完成后， Windows 系统运行 Migrate.bat ，其他操作系统运行 VoloDocs.Migrator 。完成后即可进行网站配置。
网站配置

进入 VoloDocs 目录下的 Web 文件夹，编辑 appsettings.json 中的连接字符串（需与 Migrator 配置一致）。配置完成后即可发布网站。
网站部署

完成数据库准备后，请确保连接字符串指向的数据库已就绪。
IIS 部署
- 将 Web 文件夹移至 wwwroot 目录
- 重命名文件夹为 VoloDocs （路径示例： C:\inetpub\wwwroot\VoloDocs ）
- 系统将自动创建 VoloDocs 应用池，请进入 应用池 设置：
  - .NET CLR 版本 ： No Managed Code
  - 托管管道模式 ： Integrated
- 若出现以下错误，说明服务器未安装托管捆绑包：
```
Handler "aspNetCore" has a bad module "AspNetCoreModuleV2" in its module list using IIS       
```
  请参考微软官方文档安装托管捆绑包，或直接下载安装包运行。
Azure 部署

微软提供详细的 ASP.NET Core 应用部署指南： https://docs.microsoft.com/azure/app-service/app-service-web-get-started-dotnet
命令行启动

进入 VoloDocs\Web 目录， Windows 系统运行 VoloDocs.Web.exe ， macOS/Linux 系统运行 VoloDocs.Web
首次运行

访问配置的网站地址，首次运行时需要创建项目。

创建项目

访问以下地址创建项目：
- http://<您的网站地址>/Account/Login?returnUrl=/Docs/Admin/Projects
默认登录凭据

管理员账户：
- 用户名 ： admin
- 密码： 1q2w3E*
项目配置示例

以下是以 ABP 框架文档为例的 GitHub 源配置：
- 名称： ABP
- 短名称 ： abp
- 格式： markdown
- 默认文档名 ： Index
- 导航文档名 ： docs-nav.json （示例）
- 参数文档名 ： docs-params.json （示例）
- 最低版本 ：留空（隐藏旧版本）
- 主站 URL ： /
- 最新版本分支 ：留空
- GitHub 根 URL ： https://github.com/abpframework/abp/tree/{version}/docs/
- GitHub 访问令牌 ： [ 获取方法 ](# 获取 github 访问令牌 )
- GitHub 用户代理 ： [ 查看方法 ](# 获取 github 用户名 )
- 版本来源 ： Releases （可选 Branches ）
- 版本分支前缀 ：留空
获取 GitHub 访问令牌
1. 访问 GitHub 账户设置 → 开发者设置 → 个人访问令牌
2. 点击 "Generate new token" 浏览
3. 公共仓库：勾选 repo 下的 public_repo
4. 私有仓库：勾选 repo 下所有选项
5. 点击 "Generate Token"
获取 GitHub 用户名

点击 GitHub 页面右上角头像， "Signed in as" 后显示即为用户名