diff options
author | Arturs Artamonovs <dos21h@gmail.com> | 2023-01-29 10:30:54 +0000 |
---|---|---|
committer | Arturs Artamonovs <dos21h@gmail.com> | 2023-01-29 10:30:54 +0000 |
commit | 66fa71a8f11b6ce5e8471b533f67cc3a1fdb85a8 (patch) | |
tree | 7aed7f385826a3bd88c76a373e28c6cfae4f396e /src/mistune/toc.py | |
parent | 129c1201ea5c4418f0f89ad932633c7cea2439b7 (diff) | |
download | md-site-66fa71a8f11b6ce5e8471b533f67cc3a1fdb85a8.tar.gz md-site-66fa71a8f11b6ce5e8471b533f67cc3a1fdb85a8.zip |
Update to new mistune, removed old mistune, rewrite to python3
Diffstat (limited to 'src/mistune/toc.py')
-rw-r--r-- | src/mistune/toc.py | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/src/mistune/toc.py b/src/mistune/toc.py new file mode 100644 index 0000000..c908b0c --- /dev/null +++ b/src/mistune/toc.py @@ -0,0 +1,111 @@ +from .util import striptags + + +def add_toc_hook(md, min_level=1, max_level=3, heading_id=None): + """Add a hook to save toc items into ``state.env``. This is + usually helpful for doc generator:: + + import mistune + from mistune.toc import add_toc_hook, render_toc_ul + + md = mistune.create_markdown(...) + add_toc_hook(md, level, heading_id) + + html, state = md.parse(text) + toc_items = state.env['toc_items'] + toc_html = render_toc_ul(toc_items) + + :param md: Markdown instance + :param min_level: min heading level + :param max_level: max heading level + :param heading_id: a function to generate heading_id + """ + if heading_id is None: + def heading_id(token, index): + return 'toc_' + str(index + 1) + + def toc_hook(md, state): + headings = [] + + for tok in state.tokens: + if tok['type'] == 'heading': + level = tok['attrs']['level'] + if min_level <= level <= max_level: + headings.append(tok) + + toc_items = [] + for i, tok in enumerate(headings): + tok['attrs']['id'] = heading_id(tok, i) + toc_items.append(normalize_toc_item(md, tok)) + + # save items into state + state.env['toc_items'] = toc_items + + md.before_render_hooks.append(toc_hook) + + +def normalize_toc_item(md, token): + text = token['text'] + tokens = md.inline(text, {}) + html = md.renderer(tokens, {}) + text = striptags(html) + attrs = token['attrs'] + return attrs['level'], attrs['id'], text + + +def render_toc_ul(toc): + """Render a <ul> table of content HTML. The param "toc" should + be formatted into this structure:: + + [ + (level, id, text), + ] + + For example:: + + [ + (1, 'toc-intro', 'Introduction'), + (2, 'toc-install', 'Install'), + (2, 'toc-upgrade', 'Upgrade'), + (1, 'toc-license', 'License'), + ] + """ + if not toc: + return '' + + s = '<ul>\n' + levels = [] + for level, k, text in toc: + item = '<a href="#{}">{}</a>'.format(k, text) + if not levels: + s += '<li>' + item + levels.append(level) + elif level == levels[-1]: + s += '</li>\n<li>' + item + elif level > levels[-1]: + s += '\n<ul>\n<li>' + item + levels.append(level) + else: + levels.pop() + while levels: + last_level = levels.pop() + if level == last_level: + s += '</li>\n</ul>\n</li>\n<li>' + item + levels.append(level) + break + elif level > last_level: + s += '</li>\n<li>' + item + levels.append(last_level) + levels.append(level) + break + else: + s += '</li>\n</ul>\n' + else: + levels.append(level) + s += '</li>\n<li>' + item + + while len(levels) > 1: + s += '</li>\n</ul>\n' + levels.pop() + + return s + '</li>\n</ul>\n' |