diff options
| -rw-r--r-- | .changeset/pink-pugs-beg.md | 5 | ||||
| -rw-r--r-- | packages/markdown/remark/src/rehype-escape.ts | 2 | ||||
| -rw-r--r-- | packages/markdown/remark/test/expressions.test.js | 29 |
3 files changed, 34 insertions, 2 deletions
diff --git a/.changeset/pink-pugs-beg.md b/.changeset/pink-pugs-beg.md new file mode 100644 index 000000000..ee78d3d71 --- /dev/null +++ b/.changeset/pink-pugs-beg.md @@ -0,0 +1,5 @@ +--- +'@astrojs/markdown-remark': patch +--- + +Encodes ampersand characters in code blocks diff --git a/packages/markdown/remark/src/rehype-escape.ts b/packages/markdown/remark/src/rehype-escape.ts index a32027b89..e776c1bb1 100644 --- a/packages/markdown/remark/src/rehype-escape.ts +++ b/packages/markdown/remark/src/rehype-escape.ts @@ -8,7 +8,7 @@ export default function rehypeEscape(): any { // Visit all raw children and escape HTML tags to prevent Markdown code // like "This is a `<script>` tag" from actually opening a script tag visit(el, 'raw', (raw) => { - raw.value = raw.value.replace(/</g, '<').replace(/>/g, '>'); + raw.value = raw.value.replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>'); }); } return el; diff --git a/packages/markdown/remark/test/expressions.test.js b/packages/markdown/remark/test/expressions.test.js index fdf578923..0361e1df8 100644 --- a/packages/markdown/remark/test/expressions.test.js +++ b/packages/markdown/remark/test/expressions.test.js @@ -1,5 +1,5 @@ import { renderMarkdown } from '../dist/index.js'; -import chai from 'chai'; +import chai, { expect } from 'chai'; describe('expressions', () => { it('should be able to serialize bare expression', async () => { @@ -71,6 +71,33 @@ describe('expressions', () => { ); }); + it('should be able to encode ampersand characters in code blocks', async () => { + const { code } = await renderMarkdown( + 'The ampersand in ` ` must be encoded in code blocks.', + {} + ); + + chai + .expect(code) + .to.equal( + '<p>The ampersand in <code is:raw>&nbsp;</code> must be encoded in code blocks.</p>' + ) + }); + + it('should be able to encode ampersand characters in fenced code blocks', async () => { + const { code } = await renderMarkdown(` + \`\`\`md + The ampersand in \` \` must be encoded in code blocks. + \`\`\` + `); + + chai + .expect(code) + .to.match( + /^<pre is:raw.*<code>.*The ampersand in `&nbsp;`/ + ); + }) + it('should be able to serialize function expression', async () => { const { code } = await renderMarkdown( `{frontmatter.list.map(item => <p id={item}>{item}</p>)}`, |