как написать оглавление с помощью jekyll и redcarpet

используя jekyll 2.0.3, я изначально настроил _config.yml с

markdown: kramdown

и я смог добавить в свой example.md оглавление следующим образом:

---
layout: page
title: Sample
---
{:toc}

## section 1
## section 2

однако я перешел на redcarpet, см. _config.yml:

markdown: redcarpet
redcarpet:
  extensions: ["no_intra_emphasis", "fenced_code_blocks", "autolink", "strikethrough", "superscript", "with_toc_data"]

и теперь {:toc:} не работает.

Документация redcarpet v2.2.2 (используется jekyll 2.0.3): https://github.com/vmg/redcarpet/blob/v2.2.2/README.markdown#and-its-like-really-simple-to-use

упоминает :with_toc_data, но я не знаю, где / как это использовать.

как я могу отобразить оглавление с помощью красной ковровой дорожки?


jekyll jekyll-extensions
person David Portabella    schedule 22.06.2014    source источник

Ответы (2)


arrow_upward
3
arrow_downward

Проблема здесь в том, что :with_toc_data - это опция для экземпляра средства визуализации redcarpet, а не расширение конфигурации.

К сожалению, Jekyll, похоже, не предоставляет этот параметр рендеринга, поэтому я не думаю, что вы сможете его использовать. В документах говорится:

в Jekyll нельзя указать параметры рендерера, кроме smart.

Но вместо этого вы можете использовать плагин jekyll для оглавления. Быстрый поиск возвращает несколько доступных вариантов, а ссылка на находится на официальном сайте Jekyll. .

person bwest    schedule 22.06.2014
comment
Спасибо. я вижу, что страницы github (которые используют jekyll) не поддерживают внешние плагины :( Вместо этого я буду использовать этот js: github.com/ghiculescu/jekyll-table-of-contents - person David Portabella; 23.06.2014
comment
Имейте в виду, что вы можете размещать любой статический контент на страницах github, поэтому, если вы хотите сгенерировать сайт локально с помощью своих настраиваемых плагинов, а затем отправить его на github, он будет работать - person bwest; 23.06.2014

arrow_upward
1
arrow_downward

Может, это должно сработать. Упомяните об этом в файле _config.yml.

markdown: redcarpet
redcarpet:
      extensions: [with_toc_data]

Я использую разметку в своем блоге вместе с JQuery и файлом js. Вот как это выглядит.

введите здесь описание изображения

Вот подробное руководство о том, как это сделать - Jekyll TOC

person Sharath kumar    schedule 16.04.2016