showdown

2.1.0 (2022-04-21)

BREAKING CHANGES

• the CLI no longer accepts "extra options". Instead you should pass the -c flag. To update:

before:

showdown makehtml -i foo.md -o bar.html --strikethrough --emoji

after:

showdown makehtml -i foo.md -o bar.html -c strikethrough -c emoji

2.0.4 (2022-04-21)

• test(cli): Add test for multiple config options (914129f), closes #916

Bug Fixes

• cli: cli displays the correct version number (8b48882)

Bug Fixes

• cli: fix cli to work with yargs (f8c4bd2), closes #893

2.0.0 is mostly a maintenance release. There are only a few changes beyond 1.9.1 as noted below. The major driver of this update is to update the yargs dependency to a more recent version without security issues.

Breaking Changes

• Supported Node Versions were set to match the node release schedule which at the time of writing includes Node 12.x, 14.x, 16.x and 17.x
• The yargs dependency was updated to ^17.2.1 to mitigate a security issue.
• The Showdown license has been changed from BSD-3-Clause to MIT

Bug Fixes

• allow escaping of colons (25c4420)
• reduce npm package size (35730b7), closes #619

Features

• Added ellipsis option to configure if the ellipsis unicode character is used or not. ( Thanks @VladimirV99 )
• Added a default security policy. Please report security issues to the issues tab on GitHub.

2.0.0-alpha is mostly a maintenance release. There are only a few changes beyond 1.9.1 as noted below. The major driver of this update is to update the yargs dependency to a more recent version without security issues.

Breaking Changes

• Supported Node Versions were set to match the node release schedule which at the time of writing includes Node 12.x, 14.x, 16.x and 17.x
• The yargs dependency was updated to ^17.2.1 to mitigate a security issue.
• The Showdown license has been changed from BSD-3-Clause to MIT

Bug Fixes

• allow escaping of colons (25c4420)
• reduce npm package size (35730b7), closes #619

Features

• • Added ellipsis option to configure if the ellipsis unicode character is used or not. ( Thanks @VladimirV99 )

Bug Fixes

• openLinksInNewWindow: add rel="noopener noreferrer" to links (1cd281f), closes #670

Dependecy update

• yargs: update yargs to latest version ^14.2 (dae65c6)

Version 1.9.0 introduces a new feature, the HTML to Markdown converter. This feature is still experimental and is a partial backport of the new Reverse Converter planned for version 2.0.

Bug Fixes

• italicsAndBold: fix issue with consecutive spans (#608) (5c0d67e), closes #544
• underline: fix issue with consecutive spans (81edc70)

Features

• converter.makeMarkdown: [EXPERIMENTAL] add an HTML to MD converter (e4b0e69), closes #388 #233

Bug Fixes

• emojis: fix emoji excessive size (4aca41c)
• gfm-codeblocks:
  • add support for spaces before language declaration (24bf7b1), closes #569
  • leading space no longer breaks gfm codeblocks (828c32f), closes #523
• images: fix js error when using image references (980e702), closes #585
• literalMidWordAsterisks: now parses single characters enclosed by * correctly (fe70e45), closes #478
• mentions: allow for usernames with dot, underscore and dash (dfeb1e2), closes #574
• nbsp: fix replacing of nbsp with regular spaces (8bc1f42)

Features

• splitAdjacentBlockquotes: add option to split adjacent blockquote blocks (da328f2), closes #477

Features

• completeHTMLDocument: add option to output a complete HTML document (a8427c9)
• metadata: add support for embedded metadata (63d949f), closes #260

Bug Fixes

• tables: raw html inside code tags in tables no longer breaks tables (4ef4c5e), closes #471

Bug Fixes

• literalMidWordAsterisks: no longer treats colon as alphanumeric char (21194c8), closes #461
• spanGamut: code spans are hashed after parsing (f4f63c5), closes #464
• tables: pipe character in code spans no longer breaks table (0c933a0), closes #465

Bug Fixes

• fenced codeblocks: add tilde as fenced code block delimiter (c956ede), closes #456
• openLinksInNewWindow: hash links are not affected by the option (11936ec), closes #457

Dependencies update

• package: update yargs to version 10.0.3 (#447) (906b26d)

Bug Fixes

• CDNjs: bump version to fix version missmatch with CDNjs (#452)

NOTICE

Don't use the CDNjs version of this release. See issue #452 for more details.

Bug Fixes

• autolinks: prevent _ and * to be parsed in links (61929bb), closes #444

Features

• ellipsis: add auto-ellipsis support (25f1978)

  • Example:

    input

    this is an ellipsis...
    

    output

    <p>this is an ellipsis…</p>
    

• emoji: add emoji support through option emoji(5b8f1d3), closes #448

  • Usage:

    var conv = new showdown.Converter({emoji: true});
    

  • Example:

    input

    this is a smile :smile: emoji
    

    output

    <p>this is a smile 😄 emoji</p>
    

• start ordered lists at an arbitrary number: add support for defining the first item number of ordered lists (9cdc35e), closes #377

  • Example:

    input

    3. foo
    4. bar
    5. baz
    

    output

    <ol start="3">
      <li>foo</li>
      <li>bar</li>
      <li>baz</li>
    </ol>
    

• underline: add EXPERIMENTAL support for underline (084b819), closes #450

  • Usage:

    var conv = new showdown.Converter({underline: true});
    

  • Example:

    input

    this is __underlined__ and this is ___also underlined___
    

    output

    <p>this is <u>underlined</u> and this is <u>also underlined</u></p>
    

  • Note: With this option enabled, underscore no longer parses as <em> or <strong>

BREAKING CHANGES

• start ordered lists at an arbitrary number: Since showdown now supports starting ordered lists at an arbitrary number, list output may differ.

Bug Fixes

• tables: tables are properly rendered when followed by a single linebreak and a list (d88b095), closes #443
• tables: trailing spaces no longer prevent table parsing (66bdd21), closes #442

Bug Fixes

• html-comments: changed regex to prevent malformed long comment to freeze showdown (3efcd10), closes #439

Bug Fixes

• helper.isArray: replace a.constructor === Array with Array.isArray (466a2eb), closes #425
• loader: allow AMD loader to be used within Node env (ff24bdb)

Features

• base64-wrapping: support for wrapping base64 strings (8c593a4), closes #429

Bug Fixes

• github flavor: add backslashEscapesHTMLTags to GFM flavor (5284439)
• literalMidWordAsterisks: option no longer treats punctuation as word character (8f05be7), closes #398
• tables: allow for one column table (fef110c), closes #406

Features

• rawHeaderId: Remove only spaces, ' and " from generated header ids (1791cf0), closes #409
• rawPrefixHeaderId: add option to prevent showdown from modifying the prefix (ff26c08), closes #409

Bug Fixes

• githubMentions: githubMentions now works with openLinksInNewWindow options (1194d88), closes #403
• lists: fix multi paragraph lists with sublists (a2259c0), closes #397
• tablesHeaderId: fix missmatch of option name (51e4693), closes #412

Features

• backslashEscapesHTMLTags: backslash escapes HTML tags (5a5aff6), closes #374