Skip to content

Latest commit

 

History

History
361 lines (286 loc) · 15.6 KB

CHANGELOG.md

File metadata and controls

361 lines (286 loc) · 15.6 KB

8.1.0 (2016-08-08)

New Features

  • Browserify- now easier than before! Following up on wmhilton's work from our 8.0.0 release, zeke added some scripts and docs to make using marky with Browserify even easier. Among other things, marky now ships with a browserified file ready to go! (pull/211)

Bug Fixes

  • Table troubles be gone! Or at least, any troubles with text-alignment. Marky was stripping style attributes from <td> and <th> elements- and thanks to revin's hardwork, it isn't anymore! (issues/212, pull/216)

Docs

  • A slightly new and reogranized README- refocused to make it easier for potential users of marky to learn about what marky does and wants to do! (pull/221)

Dependencies

8.0.0 (2016-07-08)

Progress toward feature parity with GitHub's markdown rendering continues...

New Features / Breaking Changes

  • get your class on: syntax highlighting now supports ES2015 (pull/206)! The changes to the rendered markup for highlighted JavaScript aren't purely additive (we wish we could be more specific, but the functionality comes from atom/language-javascript, which currently doesn't publish a changelog; if you're feeling particularly brave, there's always the diff 😳), so dependening on how your CSS works, there may or may not be non-trivial work for you to do
  • changed the way certain links are auto-generated (i.e., linkifying www.example.com but not readme.md) so as to more closely match how Github does it (pull/151, issue/146); thanks to puzrin for help working out the details
  • < and > are no longer allowed in auto-linked text due to a sub-dependency update coming in from markdown-it (see below, also linkify-it/26 for details)
  • we now allow link reference definitions to appear immediately following paragraphs rather than requiring a blank link in between them; this contradicts CommonMark but matches Github's behavior. (issue/159, pull/164)
  • we now support Github flavored markdown task lists in markdown documents. (issue/166, pull/168)
  • we no longer strip HTML <dl>, <dt>, and <dd> elements from embedded markup, so you can write definition lists. HOWEVER: these are not directly supported by any particular standard Markdown syntax; since they are treated as inline HTML, any lines indented with four or more spaces will get rendered as code blocks as per CommonMark; see the discussion in issue/169. (pull/170)
  • big thanks to wmhilton who swooped in out of the blue and made it so marky now works in a web browser! 🎉 🎉 🎉 Unfortunately, you have to specify {highlightSyntax: false} in the options because the deepest recesses of our dependency tree have some native C++ stuff which can't be browserified. On the other hand, leaving out syntax highlighting cuts the final bundle size roughly in half, so that's a win. (pull/203)
  • if you invoke marky with {highlightSyntax: false} in the options, we no longer apply the syntax highlighting-related CSS classes to the rendered HTML; e.g., rather than <div class="highlight js"><pre class="editor editor-colors">...</pre></div> we will render simply <pre><code>...</code></pre>. (issue/162, pull/163)

CommonMark 0.25

Due to the update to markdown-it (see below), our markdown parsing now uses CommonMark 0.25 (up from 0.23) as a baseline. The CommonMark 0.24 Changelog and CommonMark 0.25 Changelog have the details; the main interesting parts are:

  • setext headings can span multiple lines now

    This didn't work as a heading before
but now it does
=========

  • link destinations can no longer contain spaces, even when surrounded by angle brackets

    [link text](<this used to be valid.html>)

    Note: This has already caught a few people out; we have an issue tracking it (see issue/195) and are looking at reintroducing the more flexible (non-standard) parsing in the future.

  • valid link schemes used to be enumerated ('http', 'https', 'ftp', etc...); now they're defined as "any sequence of 2--32 characters beginning with an ASCII letter and followed by any combination of ASCII letters, digits, or the symbols plus ('+'), period ('.'), or hyphen ('-')"; in practice, this won't affect most documents, but it is more flexible and future-compatible.

Dependencies

  • markdown-it updated to 7.0.0 (pull/153)
  • added markdown-it-task-lists at 1.0.0 (pull/168)

7.0.2 (2016-07-06)

  • fixed a bug where markdown headings containing HTML links were still wrongly being wrapped with generated anchor links, thanks to jdalton for pointing it out! (issue/200, pull/201)

7.0.1 (2016-05-28)

  • removed some unused configuration option handling from the process by which we wrap markdown code blocks (pull/154)

Tests

  • unit tests were breaking when dependencies's READMEs weren't in our file tree (specifically mocha, a devDependency); now we skip trying to process those (pull/184)
  • a dependency was leaking a variable into the global scope; now we test for that; thanks aredridel! (issue/180, pull/186)
  • added some tests to make sure marky doesn't accidentally do mustache template variable replacement (issue/160, pull/161)

Dependencies

7.0.0 (2016-02-08)

Breaking Changes

  • updated markdown-it to 5.1.0 that broke the behavior of fenced code blocks. updated tests to reflect new behavior. (pull/100) by revin
  • we were seeing rendering issues because markdown-it does not do anything with tab characters in fenced code blocks. we now convert tab characters into four-spaces, which follows Github flavored markdown (issue/126,pull/127) by revin
  • converts emoji in heading IDs to emoji shortcode names to more closely match Github flavored markdown (issue/128, pull/133) filed by chrisdickinson, fixed by revin

6.0.4 (2016-02-08)

Documentation

  • badges about the time til close for PRs and issues were added to the README by ashleygwilliams
  • a line about :emoji: conversion was added to the README by revin
  • a trailing comma in the options description was removed by revin

Tests

  • originally we were installing some packages as devDependencies in order to use their READMEs in tests. this became an issue when greenkeeper would attempt to update them and break our tests :) we now have pulled in the READMEs as static assets (issue/91 pull/114), by revin
  • tests were all in a single file, broken up in categories (issue/122, pull/123) by revin
  • test coverage was greatly improved (pull/138) by revin
    • our packagize module would error out if the package provided, lacked a name, if() guard added
    • ensure that cdn module bails if there isn't sufficient package data supplied
    • add a few lines to github.md test fixture to make sure it handles <img> elements with a blank/missing src attribute and <a> elements with a blank/missing href
    • ensure running marky with {debug: true} produces the same output as normal execution

Bug Fixes

  • any URL containing "//youtube.com" was make it through our iframe filter, but the intent was to only allow actual YouTube URLs. (issue/108, pull/110), filed by lovasoa, solved by revin

Dependencies

Other

  • some code existed for creating meta tags based on README frontmatter that was not being used. it and its tests were removed. (issue/43, pull/116) by revin
  • a small module for removing HTML comments was still in the codebase but had not been used in a while. was finally fully removed (pull/121) by revin

6.0.3 (2016-01-14)

Bug Fix

  • we strip h1 tags from READMEs that have the same content as the package name, however we did not update this feature to account for scoped package names, e.g. @scope/pkg. now we remove the scope from the package meta-data to check the README's h1. (issue/48) - reported by sindresorhus, solved by revin

Documentation

Dependencies

6.0.2 (2016-01-11)

Bug Fix

  • we were parsing :) into emoji, though this is not the desired behavior. disabled shortcut emoji parsing in the markdown-it-emoji plugin. (issue/95, pull/97) - reported by cloakedninjas, solved by revin

6.0.1 (2016-01-07)

Bug Fix

  • markdown-it@5.1.0 would break the build, so package.json was updated to hold at minor version, ~5.0.2 (pull/90) - by ashleygwilliams

6.0.0 (2016-01-06)

Breaking Changes

New Features