Table of contents for long articles

[moy]

For the darktable 2.6 article (#25), I'd like to have a table of contents at the top (the article is around 30-screens long ...).

Appartently, there's a way to do that with Pelican and it seems at least partly-activated in pelicanconf.py:

# toc(permalink=True) sets all headers to have an id
# set, and an <a> after the heading.
# see: http://pythonhosted.org/Markdown/extensions/toc.html
MARKDOWN = {
  'extension_configs' : {
    #'markdown.extensions.fenced_code' : {},
    #'markdown.extensions.codehilite' : {'css_class': 'codehilite'},
    'markdown.extensions.extra' : {},
    'markdown.extensions.headerid' : {},
    'markdown.extensions.toc(permalink=)' : {}
  }
}

Unfortunately:

• Adding [TOC] in the .md files only results in having [TOC] displayed in the article :-(

• The page linked to is broken currently down, but it's still available as https://web.archive.org/web/20170513185232/http://pythonhosted.org/Markdown/extensions/toc.html

Any idea how to use TOC in darktable.org?

Thanks,

[patdavid]

I'm in the site code now and will check - may just have to make sure the plugin is active. please hold...

[patdavid]

Ok, I've got this working using my local Pelican version 3.6.3.
I had to modify the pelicanconf.py file to use the old syntax for markdown extensions. I'm not going to push anything until I can clear some details with @houz.

@houz - are we using a newer version of Pelican on the server? If so I can upgrade and test as needed.

[patdavid]

I think we might be able to include both versions of python variables in the build system without harm. I'm going to test this, and if it works we might be good to include [TOC] to automatically create a Table of Contents from headings in the .md files. Stand by.

[moy]

OK, probably best is that I let you add the [TOC] in the article, so you can easily remove it or fix the issue if it doesn't work.

Thanks for working on this.