summaryrefslogtreecommitdiff
path: root/src/micromark-collect-headers.ts
diff options
context:
space:
mode:
Diffstat (limited to 'src/micromark-collect-headers.ts')
-rw-r--r--src/micromark-collect-headers.ts7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/micromark-collect-headers.ts b/src/micromark-collect-headers.ts
index 78567699c..69781231a 100644
--- a/src/micromark-collect-headers.ts
+++ b/src/micromark-collect-headers.ts
@@ -1,7 +1,10 @@
import slugger from 'github-slugger';
-// NOTE: micromark has terrible TS types. Instead of fighting with the
-// limited/broken TS types that they ship, we just reach for our good friend, "any".
+/**
+ * Create Markdown Headers Collector
+ * NOTE: micromark has terrible TS types. Instead of fighting with the
+ * limited/broken TS types that they ship, we just reach for our good friend, "any".
+ */
export function createMarkdownHeadersCollector() {
const headers: any[] = [];
let currentHeader: any;