Skip to content

tools: update marked dependency

Checklist
  • tests and code linting passes
  • the commit message follows commit guidelines
Affected core subsystem(s)

tools

Description of change

Update module tools/doc/node_modules/marked. Customize renderer to remove id from heading.

Diff result for all.html http://106.187.89.52/tmp/diff-683f2a7-doc-html-all.html Diff result for all.json http://106.187.89.52/tmp/diff-683f2a7-doc-json-all.html

The newly updated marked module fixed several problems in the doc.

Removed unnecessary </p><p>

In addons.md:

Please see the examples below for further information or
<https://github.com/arturadib/node-qt> for an example in production.

HTML result from:

<p>Please see the examples below for further information or
</p>
<p><a href="https://github.com/arturadib/node-qt">https://github.com/arturadib/node-qt</a> for an example in production.

</p>

to:

<p>Please see the examples below for further information or
<a href="https://github.com/arturadib/node-qt">https://github.com/arturadib/node-qt</a> for an example in production.</p>
Fixed unordered list

In util.md:

`util.inspect.styles` is a map assigning each style a color
from `util.inspect.colors`.
Highlighted styles and their default values are:
 * `number` (yellow)
 * `boolean` (yellow)
 * `string` (green)
 * `date` (magenta)
 * `regexp` (red)
 * `null` (bold)
 * `undefined` (grey)
 * `special` - only function at this time (cyan)
 * `name` (intentionally no styling)

HTML result from:

<p><code>util.inspect.styles</code> is a map assigning each style a color
from <code>util.inspect.colors</code>.
Highlighted styles and their default values are:
 <em> <code>number</code> (yellow)
 </em> <code>boolean</code> (yellow)
 <em> <code>string</code> (green)
 </em> <code>date</code> (magenta)
 <em> <code>regexp</code> (red)
 </em> <code>null</code> (bold)
 <em> <code>undefined</code> (grey)
 </em> <code>special</code> - only function at this time (cyan)
 * <code>name</code> (intentionally no styling)

</p>

to:

<p><code>util.inspect.styles</code> is a map assigning each style a color
from <code>util.inspect.colors</code>.
Highlighted styles and their default values are:</p>
<ul>
<li><code>number</code> (yellow)</li>
<li><code>boolean</code> (yellow)</li>
<li><code>string</code> (green)</li>
<li><code>date</code> (magenta)</li>
<li><code>regexp</code> (red)</li>
<li><code>null</code> (bold)</li>
<li><code>undefined</code> (grey)</li>
<li><code>special</code> - only function at this time (cyan)</li>
<li><code>name</code> (intentionally no styling)</li>
</ul>
Removed redundant new lines

In addons.md:

To test:

HTML result from:

<p>To test:

</p>

to:

<p>To test:</p>
code element class name changes

It changed the class name for code element from cpp / js / javascript to lang-cpp / lang-js / lang-javascript. It does not matter because there is no style defined for these class names.

Merge request reports

Loading