blob: e464b18876842ca463bcfb725bcac482e4a102d4 [file] [log] [blame]
require 'nokogiri'
module Jekyll
module TOCGenerator
TOGGLE_HTML = '<div id="toc-title"><h2>%1</h2>%2</div>'
TOC_CONTAINER_HTML = '<div id="toc" class="toc">%1<ul>%2</ul></div>'
HIDE_HTML = '<span class="toc-toggle">[<a id="toctogglelink" class="internal" href="#">%1</a>]</span>'
def toc_generate(html)
# No Toc can be specified on every single page
# For example the index page has no table of contents
no_toc = @context.environments.first["page"]["noToc"] || false;
if no_toc
return
end
config = @context.registers[:site].config
# Minimum number of items needed to show TOC, default 0 (0 means no minimum)
min_items_to_show_toc = config["minItemsToShowToc"] || 0
anchor_prefix = config["anchorPrefix"] || 'tocAnchor-'
# Text labels
contents_label = config["contentsLabel"] || 'Table of Contents'
hide_label = config["hideLabel"] || 'hide'
show_label = config["showLabel"] || 'show'
show_toggle_button = config["showToggleButton"]
toc_html = ''
toc_level = 1
toc_section = 1
item_number = 1
level_html = ''
doc = Nokogiri::HTML(html)
# Find H1 tag and all its H2 siblings until next H1
doc.css('h2').each do |h1|
# TODO This XPATH expression can greatly improved
ct = h1.xpath('count(following-sibling::h2)')
h2s = h1.xpath("following-sibling::h3[count(following-sibling::h2)=#{ct}]")
level_html = '';
inner_section = 0;
h2s.map.each do |h2|
inner_section += 1;
anchor_id = h2['id']
# anchor_id = anchor_prefix + toc_level.to_s + '-' + toc_section.to_s + '-' + inner_section.to_s
# h2['id'] = "#{anchor_id}"
level_html += create_level_html(anchor_id,
toc_level + 1,
toc_section + inner_section,
item_number.to_s + '.' + inner_section.to_s,
h2.text,
'')
end
if level_html.length > 0
level_html = '<ul>' + level_html + '</ul>';
end
anchor_id = h1['id']
# anchor_id = anchor_prefix + toc_level.to_s + '-' + toc_section.to_s;
# h1['id'] = "#{anchor_id}"
toc_html += create_level_html(anchor_id,
toc_level,
toc_section,
item_number,
h1.text,
level_html);
toc_section += 1 + inner_section;
item_number += 1;
end
# for convenience item_number starts from 1
# so we decrement it to obtain the index count
toc_index_count = item_number - 1
if toc_html.length > 0
hide_html = '';
if (show_toggle_button)
hide_html = HIDE_HTML.gsub('%1', hide_label)
end
if min_items_to_show_toc <= toc_index_count
replaced_toggle_html = TOGGLE_HTML
.gsub('%1', contents_label)
.gsub('%2', hide_html);
toc_table = TOC_CONTAINER_HTML
.gsub('%1', replaced_toggle_html)
.gsub('%2', toc_html);
return toc_table;
end
doc.css('body').children.to_xhtml(indent:3, indent_text:" ")
else
return
end
end
private
def create_level_html(anchor_id, toc_level, toc_section, tocNumber, tocText, tocInner)
link = '<a href="#%1"><span class="toc-number">%2</span> <span class="toc-text">%3</span></a>%4'
.gsub('%1', anchor_id.to_s)
.gsub('%2', tocNumber.to_s)
.gsub('%3', tocText)
.gsub('%4', tocInner ? tocInner : '');
'<li class="toc--level-%1 toc--section-%2">%3</li>'
.gsub('%1', toc_level.to_s)
.gsub('%2', toc_section.to_s)
.gsub('%3', link)
end
end
end
Liquid::Template.register_filter(Jekyll::TOCGenerator)