-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgenerate_toc_with_btt_links.py
111 lines (102 loc) · 4.72 KB
/
generate_toc_with_btt_links.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
"""
This script generates a TOC and Back-to-top links in Markdown documents.
It scans for an existing TOC (and if available, updates it and keeps the
position of that existing TOC) and also respects the so-called reference
links section (if any, "<!-- LINKS START -->...<!-- LINKS END -->?").
The script is tailored to work in combination with an Applescript to add
the TOC to DEVONthink Markdown documents.
author: Fabrizio Musacchio (https://www.fabriziomusacchio.com)
date: 19.02.2022
"""
# %% IMPORTS
import sys
import re
text = sys.argv[1]
# %% DEFINE TOC-LEVEL
toc_level = 2
"""
define at which toc-level to start, e.g.:
2 - only account for headings h2 (##) and higher; requires that
the first occurring heading is h2 (except the document
heading in line 0)
1 - account for headings h1 (#) and higher; requires that a
the first occurring heading is h1 (except the document
heading in line 0)
"""
# %% MAIN ROUTINE
Current_Markdown_Text = sys.argv[1]
"""
The following text conversion and re-conversion has to be performed,
as the shell echo of multiline text within the Applescript introduces
a a type of linebreaks other than "\n", which is not interpretable by
Python. The following procedure re-introduces the "\n"-linebreaks:
"""
Current_Markdown_New_Text = Current_Markdown_Text.splitlines()
Current_Markdown_New_Text_tmp = [Current_Markdown_New_Text[0]]
# Current_Markdown_New_Text_tmp.append(Current_Markdown_New_Text[0])
# Scan the text for "#" and collect the TOC entries:
headline_index = 0
TOC_collector_list = []
for line_idx, line in enumerate(Current_Markdown_New_Text[1:]):
line_idx+=1
"""
line_idx starts with the value 1 and therefore the first line of the document
(the document's title) is skipped.
"""
if line.startswith("#"):
# remove any id in headlines from a previous run:
line_cleaned = re.sub(r'\s*\[.*\]', '', line)
# construct the new TOC entry:
current_heading = re.sub(r'(^\#*\s)', '', line_cleaned)
current_toc_entry=len(re.findall(r'[\#]', line_cleaned[toc_level:]))*("\t") + '1. ' + '['+current_heading+']'
current_toc_link = '(#h'+str(headline_index)+')'
TOC_collector_list.append(current_toc_entry+current_toc_link)
# update the current heading and add the id and the Back-to-top link:
newlines = '\n\n'
Current_Markdown_New_Text_tmp.append("<div style='text-align: right;'><a href='#toc'>Toc ↑</a></div>" + newlines +
line_cleaned + ' [h'+str(headline_index)+']')
headline_index += 1
elif line=="<div style='text-align: right;'><a href='#toc'>Toc ↑</a></div>":
# remove (by skipping) any existing Back-to-top link and some whitespace:
if Current_Markdown_New_Text_tmp[-1] == '':
del Current_Markdown_New_Text_tmp[-1]
else:
Current_Markdown_New_Text_tmp.append(line)
# scan for existing TOC and link sections:
toc_start_idx = 0
toc_end_idx = 0
link_start_idx= 0
for line_idx, line in enumerate(Current_Markdown_New_Text_tmp):
if line == '<!-- TOC START -->':
toc_start_idx = line_idx
if line == '<!-- TOC END -->':
toc_end_idx = line_idx
if line == '<!-- LINKS START -->':
link_start_idx= line_idx
# insert the TOC:
if toc_start_idx==0 and toc_end_idx==0:
Current_Markdown_New_Text_tmp2 = []
Current_Markdown_New_Text_tmp2+=[Current_Markdown_New_Text_tmp[0]]
Current_Markdown_New_Text_tmp2.append('\n<!-- TOC START -->')
Current_Markdown_New_Text_tmp2.append("<br><a name='toc'></a>\n\n---")
for toc_entry in TOC_collector_list:
Current_Markdown_New_Text_tmp2.append(toc_entry)
Current_Markdown_New_Text_tmp2.append('\n---\n<!-- TOC END -->')
else:
Current_Markdown_New_Text_tmp2 = []
Current_Markdown_New_Text_tmp2+=Current_Markdown_New_Text_tmp[0:toc_start_idx]
Current_Markdown_New_Text_tmp2.append('<!-- TOC START -->')
Current_Markdown_New_Text_tmp2.append("<br><a name='toc'></a>\n\n---")
for toc_entry in TOC_collector_list:
Current_Markdown_New_Text_tmp2.append(toc_entry)
Current_Markdown_New_Text_tmp2.append('\n---\n<!-- TOC END -->')
if link_start_idx==0:
Current_Markdown_New_Text_tmp2 += Current_Markdown_New_Text_tmp[toc_end_idx+1:]
else:
Current_Markdown_New_Text_tmp2 += Current_Markdown_New_Text_tmp[toc_end_idx + 1:link_start_idx]
Current_Markdown_New_Text_tmp2.append("<div style='text-align: right;'><a href='#toc'>Toc ↑</a></div>\n")
Current_Markdown_New_Text_tmp2 += Current_Markdown_New_Text_tmp[link_start_idx:]
# rejoin the processed text:
Current_Markdown_New_Text = '\n'.join(Current_Markdown_New_Text_tmp2)
# echo it back to the shell:
print(Current_Markdown_New_Text)