Skip to content

Breaking changes between v0.3.6 and v0.3.19 #1179

@vsemozhetbyt

Description

@vsemozhetbyt

Node.js uses marked v0.3.6 in its doc tools for building docs md sources.

I've tried to update marked up to v0.3.19 and compare results for the same sources set from the master branch. There are many diffs in them. I cannot enumerate and analyze all of them, but there are some I can mention by the first glance.

  1. Parsing code inside links with link references:

    Source:

    [`[[Prototype]]`][prototype-spec]
    ...
    [prototype-spec]: https://tc39.github.io/ecma262/#sec-ordinary-object-internal-methods-and-internal-slots

    HTML:

    -<a href="https://tc39.github.io/ecma262/#sec-ordinary-object-internal-methods-and-internal-slots"><code>[[Prototype]]</code></a>
    +[<code>[[Prototype]]</code>]<a href="https://tc39.github.io/ecma262/#sec-ordinary-object-internal-methods-and-internal-slots">prototype-spec</a>
  2. Node.js uses doc linking with @include directives combining all the docs in all.html file. In this file, all the Node.js doc file names are deleted from the relative link URLs, so that cross-document links become intra-document links. In v0.3.19 this deleting is broken:

    Source:

    [`fs.open()`][]
    ...
    [`fs.open()`]: fs.html#fs_fs_open_path_flags_mode_callback

    HTML:

    -<a href="#fs_fs_open_path_flags_mode_callback"><code>fs.open()</code></a>
    +<a href="fs.html#fs_fs_open_path_flags_mode_callback"><code>fs.open()</code></a>

Here is a zip with two folders with results if somebody wants to dig into all the diffs.

Sorry if this is not a relevant information concerning zero prerelease.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions