前言
笔者维护的MobileSuit项目在七月进行了一次大更新,但是由于懒一直也没有更新文档。在开学初,终于下定决心,对文档进行更新。
在之前,文档一直采用的是基于hexo的主题的一个文档模板,这个东西bug很多,用起来也很不方便。之前,了解到DocFX是专为C#设计的文档生成器,所以进行了安装和试用。
DocFX的使用
安装DocFX
DocFX只支持Windows平台。可以直接下载压缩包,也可以从巧克力安装DocFX,但是不能从winget安装(离谱)。
初始化
在项目目录处执行docfx init
即可进行初始化配置。一般的,保持默认就好了(所以说其实可以直接docfx init -q
),但是我把其中的生成目标目录 _site 改成了 docs
之后,docfx在项目目录下生成了子目录docfx_project,推荐直接把里面的内容复制到项目根目录。