Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
vsemozhetbyt opened this issue Mar 28, 2018 · 1 comment
Closed

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

vsemozhetbyt opened this issue Mar 28, 2018 · 1 comment

Comments

@vsemozhetbyt
Copy link
Contributor

vsemozhetbyt commented Mar 28, 2018

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.

@joshbruce
Copy link
Member

@vsemozhetbyt: Gonna go ahead and close this per #1106 and the zero major. We're definitely trying to fix more than we break in the long run. Thank you for the contributions you made along with point this one out. We're getting closer to having a better idea of exactly how of the mark marked is compared to the CommonMark spec (see #1160); so, hopefully a truly stable release is somewhere in the near future (compared to there just not be a release for a while).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants