Docfx 3.0.0 如何獲取 Index.html 上的 TOC

Question

這個問題和這個問題一樣。 但是 OP 回答了他自己的問題，但對我沒有幫助。

我正在嘗試創建一個類似於 Docfx 站點的文檔：

但是，當我構建項目時，我得到的 index.html 如下所示：

我的配置是這樣的：

• 在 Visual Studio 2017 中為項目安裝了 docfx.console 作為 nuget 包。
• docfx 的版本是 2.58.0。
• 我正在 Visual Studio 中構建項目，該項目生成 docfx 輸出。

我的文件夾配置是：

+MyApp.sln
 |-MyApp
   MyApp.csproj
   docfx.json
   toc.yml
   index.md
 |-_site
 |- api
   index.md
   toc.yml
 |-articles
   intro.md
   toc.md

我可以看到所有文件都在生成，但 TOC 沒有放在 index.html 上。 Docfx 教程不是很有幫助，因為它還沒有升級到最新版本。 例如， docfx init不運行，我必須使用docfx new conceptual 。 我試過了：

• 從與 docfx.json 相同的目錄中的命令提示符運行docfx new conceptual concept
• 從與 docfx.json 相同的目錄中的命令提示符運行docfx build
• 從同一目錄運行docfx serve _site --port 8182 。 但是，完成后，我的瀏覽器會告訴我檢查代理設置。

在我嘗試做的所有事情中，我可能在一個地方升級了我的 docfx 版本，但不是在 Visual Studio 中，因為在運行docfx serve我得到以下內容根路徑： 但我不確定如何還原或是否需要還原。

我絕對處於鎖定的安全環境中，我懷疑這與它有關。 有誰知道我可以如何更改哪些文件（如果有的話）以在與 index.html 相同的頁面上獲取 TOC？ 如果需要，我不介意手工編寫它，如果我只需要在配置文件中執行一次。

Answer 1

我能夠做到這一點的唯一方法是：

將articles/toc.md 更改為articles/toc.yml：

 - name: Home
   href: ../index.md (or wherever index.md relative to articles/ is)
 - name: Intro
   href: intro.md

將此添加到 docfx.json > build > content > files（包含文章的文件）：

"**/*.yml",

從 toc.yml 中取出對 home 的引用（在根目錄下）：

- name: Articles
  href: articles/
- name: API
  href: api/

我不完全清楚你的文件結構，但這是想法。

Answer 2

對我來說，有效的是更改根目錄 toc.yml。 文件名如 /index.md 的 href 不起作用，但對於文件夾它起作用。

錯誤：root toc.yml

- name: Articles
  href: articles/index.md
- name: API
  href: api/index.md

好：root toc.yml

- name: Articles
  href: articles/
- name: API
  href: api/
  topicHref: api/some.md

Answer 3

我終於找到了問題所在。 我的問題是文件夾配置。 我不得不將我的docfx.json 、 toc.yml和index.md到我的 .sln 文件所在的頂層，因為它正在訪問多個.csproj文件。 我沒有意識到頂級toc.yml只能訪問其當前位置下的文件夾。

此外，頂級toc.yml只會在頁面頂部創建菜單項。 較低級別的目錄文件將在頁面左側創建目錄。

花了一些時間研究教程才弄明白這一點。