Skip to content

HTML comments in Markdown break HTML page generation  #231

@staltz

Description

@staltz

I noticed that if I use <!-- comment --> in markdown files used for the Manual, I get an error when building the whole page:

/Users/amed/Development/RxJSNext/node_modules/esdoc/node_modules/ice-cap/out/src/IceCap.js:339
              throw _iteratorError;
              ^

TypeError: Cannot read property '1' of null
Please report this to https://github.com/chjj/marked.
    at Object.sanitizer (/Users/amed/Development/RxJSNext/node_modules/esdoc/out/src/Publisher/Builder/util.js:92:44)
    at InlineLexer.output (/Users/amed/Development/RxJSNext/node_modules/esdoc/node_modules/marked/lib/marked.js:612:26)
    at Parser.tok (/Users/amed/Development/RxJSNext/node_modules/esdoc/node_modules/marked/lib/marked.js:1075:50)
    at Parser.parse (/Users/amed/Development/RxJSNext/node_modules/esdoc/node_modules/marked/lib/marked.js:935:17)
    at Function.Parser.parse (/Users/amed/Development/RxJSNext/node_modules/esdoc/node_modules/marked/lib/marked.js:922:17)
    at marked (/Users/amed/Development/RxJSNext/node_modules/esdoc/node_modules/marked/lib/marked.js:1218:19)
    at markdown (/Users/amed/Development/RxJSNext/node_modules/esdoc/out/src/Publisher/Builder/util.js:86:42)
    at ManualDocBuilder._convertMDToHTML (/Users/amed/Development/RxJSNext/node_modules/esdoc/out/src/Publisher/Builder/ManualDocBuilder.js:295:39)
    at /Users/amed/Development/RxJSNext/node_modules/esdoc/out/src/Publisher/Builder/ManualDocBuilder.js:212:30
    at /Users/amed/Development/RxJSNext/node_modules/esdoc/out/src/Publisher/Builder/ManualDocBuilder.js:228:13

We actually really need HTML comments because we run code in markdown using https://github.com/Widdershin/markdown-doctest, and sometimes we need to skip test for a particular code example, using the comment <!-- skip-example -->.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions