table-of-contents.rst

Table of Contents

Processor name: table-of-contents

Danger

The table-of-contents tag currently requires integration with other systems, use of this tag should accompany supervision of a developer.

You can create a placeholder for a web framework (for example: Django) to insert a table of contents by using the following tag:

../../../verto/tests/assets/table-of-contents/doc_example_basic_usage.md

Tag Parameters

There are no required or optional tag parameters for table of contents.

Example

Using the following tag:

../../../verto/tests/assets/table-of-contents/doc_example_basic_usage.md

The resulting HTML would be:

../../../verto/tests/assets/table-of-contents/doc_example_basic_usage_expected.html

Overriding HTML for Table of Contents

There are no Jinja2 placeholders available when overriding the HTML for table of contents.

The default HTML for table of contents is:

../../../verto/html-templates/table-of-contents.html

Example

For example, providing the following HTML:

../../../verto/tests/assets/table-of-contents/doc_example_override_html_template.html

with the following tag:

../../../verto/tests/assets/table-of-contents/doc_example_override_html.md

would result in:

../../../verto/tests/assets/table-of-contents/doc_example_override_html_expected.html