getpelican / pelican-plugins

Collection of plugins for the Pelican static site generator
Other
1.39k stars 845 forks source link

Plugin "extract_toc" has outdated documentation #871

Open macabeus opened 7 years ago

macabeus commented 7 years ago

As a Pelican 3.7, the MD_EXTENSIONS is deprecated, then we need use MARKDOWN instead. But, the extract_toc's documentation is outdated:

To enable table of contents generation for the Markdown reader you need to set MD_EXTENSIONS = (['toc']) in your Pelican configuration file.

And I don't know how to use MARKDOWN. How to solve this?

macabeus commented 7 years ago

Update. Using MARKDOWN = {'extensions': ['toc']} I can execute the plugin. But, this causes bug in my codes inside tag ```.

justinmayer commented 6 years ago

@macabeus: Were you able to find a solution to your problem here?

raffienficiaud commented 6 years ago

It seems to work if you take the default MARKDOWN setting and add the extract_toc to it: I took the MARKDOWN from the documentation http://docs.getpelican.com/en/3.7.1/settings.html?highlight=MARKDOWN

MARKDOWN = {
    'extension_configs': {
        'markdown.extensions.codehilite': {'css_class': 'highlight'},
        'markdown.extensions.extra': {},
        'markdown.extensions.meta': {},
    },
    'output_format': 'html5',
    'extensions' : ['toc']
}