docs(tocObj): bring up

hexojs · Nov 18, 2019 · 86bce5b · 86bce5b
1 parent 1defb4c
commit 86bce5b
Showing 1 changed file with 62 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -33,6 +33,7 @@ Utilities for [Hexo].
 - [spawn](#spawncommand-args-options)
 - [stripHTML](#striphtmlstr)
 - [wordWrap](#wordwrapstr-options)
+- [tocObj](#tocobjstr-options)
 - [truncate](#truncatestr-options)
 - [unescapeHTML](#unescapehtmlstr)
 - [url_for](#url_forpath-option)
@@ -409,6 +410,67 @@ wordWrap('Once upon a time', {width: 1})
 // Once\nupon\na\ntime
 ```
 
+### tocObj(str, [options])
+
+Generate a table of contents in JSON format based on the given html string.
+
+Option | Description | Default
+--- | --- | ---
+`min_depth` | The minimum level of TOC | 0
+`max_depth` | The maximum level of TOC | 6
+
+
+``` js
+const html = [
+  '<h1 id="title_1">Title 1</h1>',
+  '<div id="title_1_1"><h2>Title 1.1</h2></div>',
+  '<h3 id="title_1_1_1">Title 1.1.1</h3>',
+  '<h2 id="title_1_2">Title 1.2</h2>',
+  '<h2 id="title_1_3">Title 1.3</h2>',
+  '<h3 id="title_1_3_1">Title 1.3.1</h3>',
+  '<h1 id="title_2">Title 2</h1>',
+  '<h2 id="title_2_1">Title 2.1</h2>'
+].join('\n');
+
+tocObj(html);
+/*
+[
+  { text: 'Title 1', id: 'title_1', level: 1 },
+  { text: 'Title 1.1', id: 'title_1_1', level: 2 },
+  { text: 'Title 1.1.1', id: 'title_1_1_1', level: 3 },
+  { text: 'Title 1.2', id: 'title_1_2', level: 2 },
+  { text: 'Title 1.3', id: 'title_1_3', level: 2 },
+  { text: 'Title 1.3.1', id: 'title_1_3_1', level: 3 },
+  { text: 'Title 2', id: 'title_2', level: 1 },
+  { text: 'Title 2.1', id: 'title_2_1', level: 2 },
+]
+*/
+
+tocObj(html, { min_depth: 2 });
+/*
+[
+  { text: 'Title 1.1', id: 'title_1_1', level: 2 },
+  { text: 'Title 1.1.1', id: 'title_1_1_1', level: 3 },
+  { text: 'Title 1.2', id: 'title_1_2', level: 2 },
+  { text: 'Title 1.3', id: 'title_1_3', level: 2 },
+  { text: 'Title 1.3.1', id: 'title_1_3_1', level: 3 },
+  { text: 'Title 2.1', id: 'title_2_1', level: 2 },
+]
+*/
+
+tocObj(html, { max_depth: 2 });
+/*
+[
+  { text: 'Title 1', id: 'title_1', level: 1 },
+  { text: 'Title 1.1', id: 'title_1_1', level: 2 },
+  { text: 'Title 1.2', id: 'title_1_2', level: 2 },
+  { text: 'Title 1.3', id: 'title_1_3', level: 2 },
+  { text: 'Title 2', id: 'title_2', level: 1 },
+  { text: 'Title 2.1', id: 'title_2_1', level: 2 },
+]
+*/
+```
+
 ### truncate(str, [options])
 
 Truncates a given text after a given `length` if text is longer than `length`. The last characters will be replaced with the `omission` option for a total length not exceeding `length`.