在 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 文件。