Skip to content

[Docs Site] Add ignore-md class for vendored Markdown #23711

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

Merged
merged 1 commit into from
Jul 16, 2025
Merged

[Docs Site] Add ignore-md class for vendored Markdown #23711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/components/overrides/PageTitle.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ const hideBreadcrumbs = Astro.locals.starlightRoute.hideBreadcrumbs;

{
component && (
<div class="sl-markdown-content">
<div class="sl-markdown-content md-ignore">
<ComponentUsage component={component} />
</div>
)
Expand Down
5 changes: 3 additions & 2 deletions src/content/docs/style-guide/components/render.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ import { Render } from "~/components";
When using the `Render` component inside partials, the original `product` is lost.

For example, if there are three files:

1. `docs/fundamentals/index.mdx`
2. `partials/dns/thing.mdx`
3. `partials/dns/thing2.mdx`
Expand Down Expand Up @@ -195,4 +194,6 @@ import { Render } from "~/components";

## Partials

<PartialsUsage />
<div class="md-ignore">
<PartialsUsage />
</div>
2 changes: 1 addition & 1 deletion src/plugins/rehype/filter-elements.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ const ALLOWED_ATTRIBUTES: Record<string, string[]> = {

const UNWRAP_CLASS_NAMES = ["heading-wrapper"];

const DISALLOWED_CLASS_NAMES = ["external-link", "anchor-link"];
const DISALLOWED_CLASS_NAMES = ["external-link", "anchor-link", "md-ignore"];

export default function () {
return function (tree: Root) {
Expand Down
2 changes: 1 addition & 1 deletion src/util/markdown.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export async function htmlToMarkdown(
url: string,
): Promise<string | undefined> {
const dom = parse(html);
const content = dom.querySelector(".sl-markdown-content");
const content = dom.querySelector(".sl-markdown-content:not(.md-ignore)");

if (!content) {
return;
Expand Down