_.${ id }`);
46 | }
47 | });
48 | }
49 |
50 | /**
51 | * Removes horizontal rules from the document.
52 | *
53 | * @private
54 | * @param {Object} $ The Cheerio object.
55 | */
56 | function removeHorizontalRules($) {
57 | $('hr').remove();
58 | }
59 |
60 | /**
61 | * Removes marky-markdown specific ids and class names.
62 | *
63 | * @private
64 | * @param {Object} $ The Cheerio object.
65 | */
66 | function removeMarkyAttributes($) {
67 | $('[id^="user-content-"]')
68 | .attr('class', null)
69 | .attr('id', null);
70 |
71 | $(':header:not(h3) > a').each(function() {
72 | const $a = $(this);
73 | $a.replaceWith($a.html());
74 | });
75 | }
76 |
77 | /**
78 | * Renames "_" id and anchor references to "lodash".
79 | *
80 | * @private
81 | * @param {Object} $ The Cheerio object.
82 | */
83 | function renameLodashId($) {
84 | $('#_').attr('id', 'lodash');
85 | $('[href="#_"]').attr('href', '#lodash');
86 | }
87 |
88 | /**
89 | * Repairs broken marky-markdown headers.
90 | * See https://github.com/npm/marky-markdown/issues/217 for more details.
91 | *
92 | * @private
93 | * @param {Object} $ The Cheerio object.
94 | */
95 | function repairMarkyHeaders($) {
96 | $('p:empty + h3').prev().remove();
97 |
98 | $('h3 ~ p:empty').each(function() {
99 | const $p = $(this);
100 | let node = this.prev;
101 | while ((node = node.prev) && node.name != 'h3' && node.name != 'p') {
102 | $p.prepend(node.next);
103 | }
104 | });
105 |
106 | $('h3 code em').parent().each(function() {
107 | const $code = $(this);
108 | $code.html($code.html().replace(/<\/?em>/g, '_'));
109 | });
110 | }
111 |
112 | /**
113 | * Cleans up highlights blocks by removing extraneous class names and elements.
114 | *
115 | * @private
116 | * @param {Object} $ The Cheerio object.
117 | */
118 | function tidyHighlights($) {
119 | $('.highlight').each(function() {
120 | let $spans;
121 | const $parent = $(this);
122 | const classes = $parent.find('.source,.text').first().attr('class').split(' ');
123 | const ext = _(classes).intersection(exts).last();
124 |
125 | $parent.addClass(ext);
126 |
127 | // Remove line indicators for single line snippets.
128 | $parent.children('pre').each(function() {
129 | const $divs = $(this).children('div');
130 | if ($divs.length == 1) {
131 | $divs.replaceWith($divs.html());
132 | }
133 | });
134 | // Remove extraneous class names.
135 | $parent.find('[class]').each(function() {
136 | const $element = $(this);
137 | const classes = $element.attr('class').split(' ');
138 | const attr = _(classes).intersection(highlights[ext]).join(' ');
139 | $element.attr('class', attr || null);
140 | });
141 | // Collapse nested comment highlights.
142 | $parent.find(`[class~="comment"]`).each(function() {
143 | const $element = $(this);
144 | $element.text($element.text().trim());
145 | });
146 | // Collapse nested string highlights.
147 | $parent.find(`[class~="string"]`).each(function() {
148 | const $element = $(this);
149 | $element.text($element.text());
150 | });
151 | // Collapse nested spans.
152 | while (($spans = $parent.find('span:not([class])')).length) {
153 | $spans.each(function() {
154 | let $span = $(this);
155 | while ($span[0] && $span[0].name == 'span' && !$span.attr('class')) {
156 | const $parent = $span.parent();
157 | $span.replaceWith($span.html());
158 | $span = $parent;
159 | }
160 | });
161 | }
162 | });
163 | }
164 |
165 | /*----------------------------------------------------------------------------*/
166 |
167 | /**
168 | * Creates the documentation HTML.
169 | *
170 | * @private
171 | */
172 | function build() {
173 | const markdown = fs
174 | // Load markdown.
175 | .readFileSync(readmePath, 'utf8')
176 | // Uncomment docdown HTML hints.
177 | .replace(/(<)!--\s*|\s*--(>)/g, '$1$2');
178 |
179 | const $ = marky(markdown, { 'sanitize': false });
180 | const $header = $('h1').first().remove();
181 | const version = $header.find('span').first().text().trim().slice(1);
182 |
183 | // Auto-link Lodash method references.
184 | autoLink($);
185 | // Rename "_" id references to "lodash".
186 | renameLodashId($);
187 | // Remove docdown horizontal rules.
188 | removeHorizontalRules($);
189 | // Remove marky-markdown attribute additions.
190 | removeMarkyAttributes($);
191 | // Repair marky-markdown wrapping around headers.
192 | repairMarkyHeaders($);
193 | // Cleanup highlights.
194 | tidyHighlights($);
195 |
196 | const html = [
197 | // Append YAML front matter.
198 | '---',
199 | 'id: docs',
200 | 'layout: docs',
201 | 'title: Lodash Documentation',
202 | 'version: ' + (version || null),
203 | '---',
204 | '',
205 | // Wrap in raw tags to avoid Liquid template tag processing.
206 | '{% raw %}',
207 | $.html().trim(),
208 | '{% endraw %}',
209 | ''
210 | ].join('\n');
211 |
212 | fs.writeFile(path.join(docPath, version + '.html'), html, util.pitch);
213 | }
214 |
215 | build();
216 |
--------------------------------------------------------------------------------
/test/backbone.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | |
17 |
18 |
24 |
25 |
26 |
31 |
32 |
33 |
34 |
78 |
79 |
80 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
44 |
45 |
46 |
47 |
48 |
49 | Inspect
50 |
51 |
52 |
53 |
56 |
57 |
58 |
63 |
64 |
65 |
66 |
67 |
68 |
69 |
73 |
74 |
75 |
76 |
77 |
81 |
82 |
83 |
136 |
137 |
138 |
84 |
85 |
86 | Console
87 |
88 |
89 |
90 |
91 |
92 | HTML
93 |
94 |
95 |
96 |
97 | CSS
98 |
99 |
100 |
101 |
102 | Script
103 |
104 |
105 |
106 |
107 | DOM
108 |
109 |
110 |
111 |
112 |
113 |
114 |
134 |
135 |
115 |
132 |
133 | |
141 | |
|
148 |
149 |
150 |
151 |
152 | |
153 |
154 |
155 |
156 |
157 |
158 |
162 |
163 |
164 |
165 |
166 |
167 |
168 |
169 |
170 |
171 |
172 |
173 |
174 |
180 |
181 | |
182 |
183 |
| 190 | 195 | | 196 | 197 ||