Class | Kramdown::Converter::Toc |
In: |
lib/kramdown/converter/toc.rb
|
Parent: | Base |
Converts a Kramdown::Document to an element tree that represents the table of contents.
The returned tree consists of Element objects of type :toc where the root element is just used as container object. Each :toc element contains as value the wrapped :header element and under the attribute key :id the header ID that should be used (note that this ID may not exist in the wrapped element).
Since the TOC tree consists of special :toc elements, one cannot directly feed this tree to other converters!