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.

Sign up for GitHub

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

Adds dataLanguage property to the replacement <pre> element. #10538

Merged
merged 14 commits into from
Apr 10, 2024
Merged

Adds dataLanguage property to the replacement <pre> element. #10538

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
7beddd4
Update highlight.ts
604qgc Apr 3, 2024
0cd199c
Create cold-snakes-train.md
bluwy Apr 4, 2024
5e0c1b0
Merge branch 'main' into main
604qgc Apr 5, 2024
b98437d
Merge branch 'withastro:main' into main
604qgc Apr 8, 2024
fc60183
Update Code.astro
604qgc Apr 8, 2024
31aa5be
Merge branch 'withastro:main' into main
604qgc Apr 9, 2024
41b50a9
roll-back initial fix
604qgc Apr 9, 2024
ba8063e
new fix
604qgc Apr 9, 2024
db66313
update changeset
604qgc Apr 9, 2024
c091465
Update packages/markdown/remark/src/rehype-prism.ts
bluwy Apr 10, 2024
612a2d5
Update .changeset/cold-snakes-train.md
matthewp Apr 10, 2024
5c463fc
Update .changeset/cold-snakes-train.md
matthewp Apr 10, 2024
538b67f
Update .changeset/cold-snakes-train.md
matthewp Apr 10, 2024
52f3cd7
Update .changeset/cold-snakes-train.md
matthewp Apr 10, 2024
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/cold-snakes-train.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@astrojs/markdown-remark": minor
---

Adds a `data-language` attribute on the rendered `pre` and `code` elements to expose the highlighted syntax language
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add a usage example?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Adds a `data-language` attribute on the rendered `pre` and `code` elements to expose the highlighted syntax language
Adds a `data-language` attribute on the rendered `pre` and `code` elements to expose the highlighted syntax language.
This allows retrieving the language in a rehype plugin:
```js
// myRehypePre.js
import { visit } from "unist-util-visit";
export default function myRehypePre() {
return (tree) => {
visit(tree, { tagName: "pre" }, (node) => {
const lang = node.properties.dataLanguage;
[...]
});
};
}
```

Hi @604qgc ! I was thinking of including something like this in the changeset, since for minor releases of new features we do like to show them off a bit and really help people understand why your thing is cool! 💅

I took this from your PR description, but if there's something else you'd prefer to use, or would change this in some way, please do! I think a changeset of this style/length is helpful to people to understand the new feature, so anything like this you can suggest would be great.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @sarah11918 !
I added some more notes for clarity, but happy to trim if that's a bit too long db66313

5 changes: 3 additions & 2 deletions packages/astro/components/Code.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,10 @@ const highlighter = await getCachedHighlighter({
wrap,
});

const html = await highlighter.highlight(code, typeof lang === 'string' ? lang : lang.name, {
const finalLang = typeof lang === 'string' ? lang : lang.name
const html = await highlighter.highlight(code, finalLang, {
inline,
attributes: rest as any,
attributes: {...rest, dataLanguage: finalLang} as any,
});
---

Expand Down
4 changes: 4 additions & 0 deletions packages/markdown/remark/src/highlight.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,10 @@ export async function highlightCodeBlocks(tree: Root, highlighter: Highlighter)
const html = await highlighter(code, language, { meta });
// The replacement returns a root node with 1 child, the `<pr>` element replacement.
const replacement = fromHtml(html, { fragment: true }).children[0] as Element;

// Adds dataLanguage property to replacement `<pre>`
replacement.properties.dataLanguage = language

// We just generated this node, so any positional information is invalid.
removePosition(replacement);

Expand Down
Loading