learn icon indicating copy to clipboard operation
learn copied to clipboard

Markdown files do not accept apostrophes

Open swaminator opened this issue 6 years ago • 2 comments

If your text content has an apostrophe ' the build fails. As an example

description: 'In this workshop **we'll** learn how to build cloud-enabled web applications with Angular & AWS Amplify.'
banner: './banner.png'

This will cause:

error Error processing Markdown file /Users/nsswamin/workspace/documentation/community/content/posts/2019-04-12-angular-workshop/index.md:

      can not read a block mapping entry; a multiline key may not be an implicit key at line 4, column 7:
    banner: './banner.png'
          ^
error Command failed with exit code 1.

swaminator avatar May 10 '19 07:05 swaminator

That's just how the MD is parsed. If wrapped with double quotes, the sentence shouldn't error out. Even with the apostrophe. Our MD linter should catch this class of build error.

harrysolovay avatar May 13 '19 19:05 harrysolovay

We need to figure out how to do this so reopening.

swaminator avatar May 29 '19 16:05 swaminator