问题标签 [docfx]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
documentation-generation - 如何自定义 Docfx 文档(主题或模板)?
我刚开始使用 Docfx 并设置了一些基本的概念文档。现在我想对主题进行一些调整(公司徽标,也许是一些字体更改等)。 小东西。
官方文档仅对如何创建新模板进行了高级描述。我以前从未使用过模板语言,所以如果可能的话,我现在想避免这种情况。
我的问题是:我怎样才能对默认主题进行小幅调整,比如一些 CSS 更改,或者添加外部资源(比如 font awesome)?
我必须创建整个模板(或其中的一部分)还是可以以某种方式包含 CSS 文件?该文档提到了一个theme
选项,但到目前为止,我还没有找到可以学习的示例或现有主题。
一个使用自定义主题或模板的项目的链接已经非常有用。docfx repo有一个docfx.website.themes
文件夹,我相信默认模板也在那里,但我真的不知道我必须提供哪些文件才能推出自己的文件。
c# - 让微软的 DocFX 在 Visual Studio 中工作
- 我下载了 DocFX 并从http://dotnet.github.io/docfx/安装了它。
- 我将它添加到我的环境路径中。然后我从https://github.com/docascode/docfx-seed下载了示例解决方案,并将其作为网站项目打开。(此示例已包含包 docfx.msbuild)
文档说要构建解决方案,然后浏览网站的 _src 文件夹。我这样做并且解决方案构建良好:
------ 构建开始:项目:docfx-seed-master,配置:调试任何 CPU ------ 验证网站构建目录'/src/SampleClass1/BaseClass/obj/Debug/'。构建目录'/src/SampleClass1/BaseClass/Properties/'。构建目录'/src/SampleClass1/BaseClass/'。构建目录'/src/SampleClass1/CatLibrary/obj/Debug/'。构建目录'/src/SampleClass1/CatLibrary/Properties/'。构建目录'/src/SampleClass1/CatLibrary/'。构建目录'/src/SampleClass1/SomeVbClass/My Project/'。构建目录'/src/SampleClass1/SomeVbClass/'。
验证完成 ========== 构建:1 个成功或最新,0 个失败,0 个跳过 ==========
但没有生成 _src 文件夹。但是,如果我从命令行运行 docfx,那么我确实会得到一个 _src 文件夹,并且可以浏览生成的网站。
所以我通过 MSBuild 将 DocFX 集成到 VS2015 以某种方式被破坏了。任何人都可以阐明如何使其正常工作吗?
docfx - DocFX 输出到 Markdown
查看流程 DocFX 似乎创建 .md 文件,然后在创建文档时将其转换为 html。
有没有办法让 DocFX 输出到 .md 文件而不是 html ?
.net - DocFx:如何在网站上创建目录导航?
我想创建一个类似于DocFx 在其官方网站上的目录:
使用使用所有默认值的默认docfx init
命令,我的网站在构建时看起来像这样:
我试过篡改 toc.yml 文件,但没有这样的运气。我如何获得这种导航,以及如何使用 DocFx 进行顶级导航?
c# - Docfx API 参考 - 无法解析查看标签
我按照本教程为类库创建 API 文档。
在我的类库的注释中,我使用see标记来引用其他类型。
例如,这是包含System.Action扩展方法的类的注释:
docfx 为上述评论创建以下 YAML 源:
最终的 HTML 输出包含相同的字符串:
我希望docfx 要么创建对System.Action的引用,要么忽略该标签。
如何让docfx“正确”呈现标签?
python-sphinx - dotnet 实用程序 (dnu) 是否已停用?什么取代了全局命令?
在与guidesphinx-autoapi
集成docfx
之后,他们建议docfx
使用以下命令进行安装:
使用 DNU 安装 DocFX(已弃用?)
DNU是否退休了 - 我刚结束使用Chocolatey,但似乎全局命令已在 .NET Core CLI 中删除。希望有人可以确认.NET Utilities发生了什么。
使用 Chocolatey 安装 DocFX
documentation-generation - DocFX:为多个项目生成 API 文档
我正在开发一个解决方案中包含多个项目的项目。我希望能够从外部目录生成文档以保持应用程序代码文件夹的清洁。当我尝试在我的docfx.json 中设置src 目录时,它似乎不喜欢绝对路径,也不喜欢相对路径。
它说它构建得很好,但没有找到任何文件,并且它搜索的目录保留在当前目录中。
当我尝试将相对路径放在 files 属性中时,我得到以下信息:
所以我的困惑似乎在于如何使用 src 选项。如果在元数据中使用 src,那么我似乎无法指定文件和排除信息。我尝试使用与元数据相同级别的 src 属性,但这似乎无济于事。