在 github 個帶有 .md 文件的頁面上添加左側導航欄

Question

我想為 GitHub 中的項目創建一些文檔。

我可以看到，GitHub 已經為 GitHub 頁提供了這些選項。 在介紹視頻中，我可以看到您可以使用多個頁面（.md 文件）和導航。

我已經添加了 Jekyll。

但：

• 我找不到如何添加左側導航欄
• 如何組織文件，以便它知道在哪里可以找到其他頁面

現在我有

-> Root
  |
  -> _config.yml
  -> about.md
  -> index.md
  -> README.md
  -> docs
     |
     -> first_page.md
     -> second_page.md

我有的配置文件

title: title
description: YOUR DESCRIPTION
baseurl: 'our_domain'
kramdown:
  math_engine: mathjax
  syntax_highlighter: rouge
plugins:
  - jekyll-default-layout

# Navigation
# List links that should appear in the site sidebar here
navigation:
  - text: Documentation
    internal: true
    url: ./docs

Answer 1

本傑明提到的文檔主題在默認布局中包含一個側邊欄，使用{% include components/sidebar.html %}這個sidebar.html非常有趣，但是關於如何做到這一點的一個相當復雜的例子，包括其他文件等。

簡而言之：

1. 調整布局。
2. 循環某種數據文件，或者在你的情況下 site.navigation
3. 使用返回的信息（文本、內部、url）並將其包含在您的側邊欄中。

非常簡單的例子：

<nav>
  <ul>
    {% for item in site.navigation %}
      <li>
        <a href="{{ item.url }}">{{ item.text }}</a>
      </li>
    {% endfor %}
  </ul>
</nav>

Jekyll 文檔包含有關如何循環此類文件的更簡單示例。 該文檔還解釋了如何為此使用 _data 文件夾中的 YAML 文件。