Skip to content

Commit 3f69ea5

Browse files
firedfoxaddaleax
firedfox
authored and
addaleax
committed
tools: update marked dependency
Update module marked. Customize renderer to remove id from heading. PR-URL: nodejs#6396 Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
1 parent 4d4cfb2 commit 3f69ea5

18 files changed

Lines changed: 2052 additions & 438 deletions

File tree

‎test/doctool/test-doctool-json.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ var testData = [
8181
'added': ['v1.0.0']
8282
},
8383
'desc': '<p>Describe <code>Foobar</code> in more detail ' +
84-
'here.\n\n</p>\n',
84+
'here.</p>\n',
8585
'type': 'module',
8686
'displayName': 'Foobar'
8787
},
@@ -92,7 +92,7 @@ var testData = [
9292
'added': ['v5.3.0', 'v4.2.0']
9393
},
9494
'desc': '<p>Describe <code>Foobar II</code> in more detail ' +
95-
'here.\n\n</p>\n',
95+
'here.</p>\n',
9696
'type': 'module',
9797
'displayName': 'Foobar II'
9898
},
@@ -104,15 +104,15 @@ var testData = [
104104
'deprecated': ['v2.0.0']
105105
},
106106
'desc': '<p>Describe <code>Deprecated thingy</code> in more ' +
107-
'detail here.\n\n</p>\n',
107+
'detail here.</p>\n',
108108
'type': 'module',
109109
'displayName': 'Deprecated thingy'
110110
},
111111
{
112112
'textRaw': 'Something',
113113
'name': 'something',
114-
'desc': '<!-- This is not a metadata comment -->\n\n<p>' +
115-
'Describe <code>Something</code> in more detail here.\n</p>\n',
114+
'desc': '<!-- This is not a metadata comment -->\n<p>' +
115+
'Describe <code>Something</code> in more detail here.</p>\n',
116116
'type': 'module',
117117
'displayName': 'Something'
118118
}

‎tools/doc/html.js‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@ const typeParser = require('./type-parser.js');
99

1010
module.exports = toHTML;
1111

12+
// customized heading without id attribute
13+
var renderer = new marked.Renderer();
14+
renderer.heading = function(text, level) {
15+
return '<h' + level + '>' + text + '</h' + level + '>\n';
16+
};
17+
marked.setOptions({
18+
renderer: renderer
19+
});
20+
1221
// TODO(chrisdickinson): never stop vomitting / fix this.
1322
var gtocPath = path.resolve(path.join(
1423
__dirname,

‎tools/doc/json.js‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@ module.exports = doJSON;
88
const common = require('./common.js');
99
const marked = require('marked');
1010

11+
// customized heading without id attribute
12+
var renderer = new marked.Renderer();
13+
renderer.heading = function(text, level) {
14+
return '<h' + level + '>' + text + '</h' + level + '>\n';
15+
};
16+
marked.setOptions({
17+
renderer: renderer
18+
});
19+
1120
function doJSON(input, filename, cb) {
1221
var root = {source: filename};
1322
var stack = [root];

‎tools/doc/node_modules/marked/.travis.yml‎

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎tools/doc/node_modules/marked/Gulpfile.js‎

Lines changed: 22 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎tools/doc/node_modules/marked/LICENSE‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎tools/doc/node_modules/marked/Makefile‎

Lines changed: 4 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)