Markdown中的目录,仅使用标准/开箱即用的Github Pages工具?

时间:2018-01-03 05:06:56

标签: jekyll github-pages

尝试使用纯托管/“开箱即用”设置博客/文档GitHub Pages Jekyll;我特意试图避免在本地运行Jekyll(尽管我可以)。

我尝试了http://www.seanbuscay.com/blog/jekyll-toc-markdown/,但这不起作用。

这可能,还是真的需要额外的工具?

1 个答案:

答案 0 :(得分:5)

默认情况下,Jekyll使用Kramdown,它已经附带了TOC生成器。你不需要一个插件,因此它可以使用github-pages。

  

kramdown支持自动生成目录   所有具有ID集的标头。只需指定引用名称“toc”   通过使用IAL到有序或无序列表,列表将是   替换为实际的目录,呈现为嵌套   如果“toc”应用于无序列表,则为无序列表,或者为   嵌套的有序列表。应用于原始列表的所有属性都将   也可以应用于生成的TOC列表,它将获得ID   如果没有设置ID,则为markdown-toc。

# Contents
{:.no_toc}

* Will be replaced with the ToC, excluding the "Contents" header
{:toc}

# H1 header

## H2 header

那会给你:

  <h1 class="no_toc" id="contents">Contents</h1>

<ul id="markdown-toc">
  <li><a href="#h1-header" id="markdown-toc-h1-header">H1 header</a>    <ul>
      <li><a href="#h2-header" id="markdown-toc-h2-header">H2 header</a></li>
    </ul>
  </li>
</ul>

<h1 id="h1-header">H1 header</h1>

<h2 id="h2-header">H2 header</h2>

https://kramdown.gettalong.org/converter/html.html#toc