MikyWang/DocSetConverter

生成中文版DocSet文档，支持Dash Zeal导入使用。

DocSetConverter

手册预览图

用途

由于Dash中几乎没有中文手册，所以本工程根据中文网页版API文档镜像成本地文档，再转换成DocSet文档，支持Dash Zeal导入使用。

已生成的手册

可 单击加入QQ群 后在群文件内下载以下手册：

• Unity Manual 中文手册
• Unity ScriptReference 中文手册
• .Net6.0 API 中文手册
• C# Manual 中文手册

自行制作方法

1. 安装 httrack ,macos 下可使用 homebrew 进行安装：

   brew install httrack

2. 下载最新的 Release 压缩包：

   https://github.com/MikyWang/DocSetConverter/releases

3. 解压。

4. 在net6.0同级目录新建目录及DocSet文件：

   cd net6.0
   mkdir unity
   mkdir -p unity/Unity3D-Chinese.docset/Contents/Resources/Documents/

5. 执行脚本将网站镜像至本地：

   ./unity-toc.sh unity/unity-docs
   mv unity/unity-docs/docs.unity.cn/cn/current/Manual unity/Unity3D-Chinese.docset/Contents/Resources/Documents/
   mv unity/unity-docs/docs.unity.cn/cn/current/ScriptReference unity/Unity3D-Chinese.docset/Contents/Resources/Documents/

6. 打开 net6.0目录中 appsettings.json ，将DocSetPath的值设置为docset文件的绝对路径：

   {
     "DocSetConfig": {
       "DocSetName": "Unity3D-Chinese",
       "DocSetShortName": "UnityChinese",
       "DocSetPath": "unity",
       "DashIndexFilePath": "Manual/index.html"
     }
   }

7. 执行文档转换程序：

   ./UnityDocConverter

8. 等待手册制作完成后，关闭终端，将unity目录下的 Unity3D-Chinese.docset 导入至 Dash 或 Zeal 中。

9. 打开 Unity3D-Chinese 文档。