Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Allow self-closing tags in Markdown again #3516

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/late-swans-impress.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@astrojs/markdown-remark': patch
---

Fix: Allow self-closing tags in Markdown
37 changes: 36 additions & 1 deletion packages/markdown/remark/src/remark-mdxish.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,50 @@
import { mdxjs } from 'micromark-extension-mdxjs';
import { mdxFromMarkdown, mdxToMarkdown } from './mdast-util-mdxish.js';
import type * as fromMarkdown from 'mdast-util-from-markdown';
import type { Tag } from 'mdast-util-mdx-jsx';

export default function remarkMdxish(this: any, options = {}) {
const data = this.data();

add('micromarkExtensions', mdxjs(options));
add('fromMarkdownExtensions', mdxFromMarkdown());
add('fromMarkdownExtensions', makeFromMarkdownLessStrict(mdxFromMarkdown()));
add('toMarkdownExtensions', mdxToMarkdown());

function add(field: string, value: unknown) {
const list = data[field] ? data[field] : (data[field] = []);
list.push(value);
}
}

function makeFromMarkdownLessStrict(extensions: fromMarkdown.Extension[]) {
extensions.forEach(extension => {
// Fix exit handlers that are too strict
['mdxJsxFlowTag', 'mdxJsxTextTag'].forEach(exitHandler => {
if (!extension.exit || !extension.exit[exitHandler])
return;
extension.exit[exitHandler] = chainHandlers(
fixSelfClosing,
extension.exit[exitHandler]
);
});
});

return extensions;
}

const selfClosingTags = new Set([
'area', 'base', 'br', 'col', 'embed', 'hr', 'img', 'input', 'link', 'meta', 'source',
'track', 'wbr'
]);

function fixSelfClosing(this: fromMarkdown.CompileContext) {
const tag = this.getData('mdxJsxTag') as Tag;
if (tag.name && selfClosingTags.has(tag.name))
tag.selfClosing = true;
}

function chainHandlers(...handlers: fromMarkdown.Handle[]) {
return function handlerChain (this: fromMarkdown.CompileContext, token: fromMarkdown.Token) {
handlers.forEach(handler => handler.call(this, token));
};
}
16 changes: 16 additions & 0 deletions packages/markdown/remark/test/strictness.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import { renderMarkdown } from '../dist/index.js';
import chai from 'chai';

describe('strictness', () => {
it('should allow self-closing HTML tags (void elements)', async () => {
const { code } = await renderMarkdown(
`Use self-closing void elements<br>like word<wbr>break and images: <img src="hi.jpg">`,
{}
);

chai.expect(code).to.equal(
`<p>Use self-closing void elements<br />like word<wbr />break and images: ` +
`<img src="hi.jpg" /></p>`
);
});
});