Skip to content

[docs-infra] Display "View as Markdown" only on Material UI #46861

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 3 commits into from
Sep 4, 2025
Merged

[docs-infra] Display "View as Markdown" only on Material UI #46861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f89da1a
keep only material ui
siriwatknp Sep 3, 2025
0180c6e
extract MarkdownIcon
siriwatknp Sep 3, 2025
454e132
fix import path
siriwatknp Sep 3, 2025
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
53 changes: 19 additions & 34 deletions packages/mui-docs/src/ComponentLinkHeader/ComponentLinkHeader.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ import Chip from '@mui/material/Chip';
import Tooltip from '@mui/material/Tooltip';
import ChatRounded from '@mui/icons-material/ChatRounded';
import GitHubIcon from '@mui/icons-material/GitHub';
import SvgIcon from '@mui/material/SvgIcon';
import { styled } from '@mui/material/styles';
import { MarkdownHeaders } from '@mui/internal-markdown';
import MarkdownIcon from '../svgIcons/MarkdownIcon';
import SketchIcon from '../svgIcons/SketchIcon';
import FigmaIcon from '../svgIcons/FigmaIcon';
import BundleSizeIcon from '../svgIcons/BundleSizeIcon';
Expand Down Expand Up @@ -61,39 +61,24 @@ export function ComponentLinkHeader(props: ComponentLinkHeaderProps) {

return (
<Root>
<li>
<Chip
clickable
role={undefined}
component="a"
size="small"
variant="outlined"
href={`${router.pathname}.md`}
icon={
<SvgIcon>
<svg
width="16"
height="16"
viewBox="0 0 24 24"
fill="none"
xmlns="http://www.w3.org/2000/svg"
aria-hidden="true"
>
<title>Markdown</title>
<path
d="M22.269 19.385H1.731a1.73 1.73 0 0 1-1.73-1.73V6.345a1.73 1.73 0 0 1 1.73-1.73h20.538a1.73 1.73 0 0 1 1.73 1.73v11.308a1.73 1.73 0 0 1-1.73 1.731zm-16.5-3.462v-4.5l2.308 2.885 2.307-2.885v4.5h2.308V8.078h-2.308l-2.307 2.885-2.308-2.885H3.461v7.847zM21.231 12h-2.308V8.077h-2.307V12h-2.308l3.461 4.039z"
fill="currentColor"
/>
</svg>
</SvgIcon>
}
data-ga-event-category="ComponentLinkHeader"
data-ga-event-action="click"
data-ga-event-label="Markdown"
data-ga-event-split="0.1"
label="View as Markdown"
/>
</li>
{packageName === '@mui/material' && (
<li>
<Chip
clickable
role={undefined}
component="a"
size="small"
variant="outlined"
href={`${router.pathname}.md`}
icon={<MarkdownIcon />}
data-ga-event-category="ComponentLinkHeader"
data-ga-event-action="click"
data-ga-event-label="Markdown"
data-ga-event-split="0.1"
label="View as Markdown"
/>
</li>
)}
{headers.githubLabel ? (
<li>
<Chip
Expand Down
23 changes: 23 additions & 0 deletions packages/mui-docs/src/svgIcons/MarkdownIcon.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import * as React from 'react';
import SvgIcon, { SvgIconProps } from '@mui/material/SvgIcon';

export default function MarkdownIcon(props: SvgIconProps) {
return (
<SvgIcon {...props}>
<svg
width="16"
height="16"
viewBox="0 0 24 24"
fill="none"
xmlns="http://www.w3.org/2000/svg"
aria-hidden="true"
>
<title>Markdown</title>
<path
d="M22.269 19.385H1.731a1.73 1.73 0 0 1-1.73-1.73V6.345a1.73 1.73 0 0 1 1.73-1.73h20.538a1.73 1.73 0 0 1 1.73 1.73v11.308a1.73 1.73 0 0 1-1.73 1.731zm-16.5-3.462v-4.5l2.308 2.885 2.307-2.885v4.5h2.308V8.078h-2.308l-2.307 2.885-2.308-2.885H3.461v7.847zM21.231 12h-2.308V8.077h-2.307V12h-2.308l3.461 4.039z"
fill="currentColor"
/>
</svg>
</SvgIcon>
);
}
Loading