Skip to content

CSM-Link/docfx-UnityDocumentGenerator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 

Repository files navigation

在本地构建 Unity Package 中的文档

在线版文档

image-20250704170521532

本地构建版文档

image-20250704170542983

使用要求

保证电脑中安装了如下工具:

使用说明

1、复制 src 中的文件到任意位置新创建的空文件夹中,并复制 Unity Package 中的 Documentation~ 文件夹到该文件夹中。【也可以将其他文件夹复制过去,md 文件可能引用其他文件夹中的示例代码】

如下方所示:

image-20250704170103445

2、使用 python 运行 md_to_toc.py,将 Documentation~/TableOfContents.md 转化为 toc.yml 文件

3、使用 docfx 执行如下命令

docfx docfx.json --serve

About

使用 docfx 在本地构建 unity package 中的文档

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages