Add support for tables of contents in articles #1

lucidiot · 2021-01-31T20:55:07Z

lucidiot commented

2021-01-31 20:55:07 +00:00

First-time contributor

In the #javapool article, ~m455 used vim-markdown-toc to add a nice little table of contents. This probably works with most Markdown flavors including Pandoc, but the Python Markdown package is pretty strict to the original Markdown spec (not even following CommonMark 😢) and does not add id attributes to titles, so clicking any link in this TOC will not work at all.

This just adds the official TocExtension from the package so we can add [TOC] to any Markdown file and get that table of contents with id attributes on titles.

In the [#javapool](http://tilde.town/wiki/socializing/irc/channels/javapool.html) article, ~m455 used [vim-markdown-toc](https://github.com/mzlogin/vim-markdown-toc) to add a nice little table of contents. This probably works with most Markdown flavors including Pandoc, but the Python Markdown package is pretty strict to the original Markdown spec (not even following [CommonMark](https://commonmark.org/) 😢) and does not add `id` attributes to titles, so clicking any link in this TOC will not work at all. This just adds the official [TocExtension](https://python-markdown.github.io/extensions/toc/) from the package so we can add `[TOC]` to any Markdown file and get that table of contents with `id` attributes on titles.

❤️ 1

m455 commented

2021-01-31 21:25:11 +00:00

Sounds good, lucidiot!

This pull request can be merged automatically.

You are not authorized to merge this pull request.

View command line instructions.

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u toc-extension:lucidiot-toc-extension

git checkout lucidiot-toc-extension

Sign in to join this conversation.

2 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: tildetown/tilde-wiki#1