Skip to content

[docs-infra] Add link to the source in API page if available #43387

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 8 commits into from
Aug 27, 2024
Merged

[docs-infra] Add link to the source in API page if available #43387

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
136f4a1
Support versioned code for source links
alexfauquette Aug 21, 2024
04ad61e
Add link in API page
alexfauquette Aug 21, 2024
3e9de7b
fixes
alexfauquette Aug 21, 2024
4e61a09
feedback
alexfauquette Aug 24, 2024
7dbb82c
make it fail
alexfauquette Aug 26, 2024
8f5de57
Merge remote-tracking branch 'upstream/next' into fix-source-link
alexfauquette Aug 26, 2024
38b7b86
fix-checkout
alexfauquette Aug 26, 2024
926c6cc
dedupe
alexfauquette Aug 26, 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
20 changes: 20 additions & 0 deletions docs/src/modules/components/ApiPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,26 @@ export default function ApiPage(props: ApiPageProps) {
layoutStorageKey={layoutStorageKey.classes}
displayClassKeys
/>

{pageContent.filename ? (
<div
className="MuiCallout-root MuiCallout-info"
style={{
alignItems: 'baseline',
gap: '4px',
marginTop: 0,
}}
>
<p
dangerouslySetInnerHTML={{
__html: t('api-docs.seeSourceCode').replace(
'{{href}}',
`${process.env.SOURCE_CODE_REPO}/blob/v${process.env.LIB_VERSION}${pageContent.filename}`,
),
}}
/>
</div>
) : null}
</MarkdownElement>
<svg style={{ display: 'none' }} xmlns="http://www.w3.org/2000/svg">
<symbol id="anchor-link-icon" viewBox="0 0 12 6">
Expand Down
2 changes: 1 addition & 1 deletion packages/mui-docs/src/ComponentLinkHeader/ComponentLinkHeader.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ export function ComponentLinkHeader(props: ComponentLinkHeaderProps) {
size="small"
variant="outlined"
rel="nofollow"
href={`${process.env.SOURCE_CODE_REPO}/tree/${process.env.SOURCE_GITHUB_BRANCH}/${headers.githubSource}`}
href={`${process.env.SOURCE_CODE_REPO}/blob/v${process.env.LIB_VERSION}/${headers.githubSource}`}
icon={<GitHubIcon />}
data-ga-event-category="ComponentLinkHeader"
data-ga-event-action="click"
Expand Down
1 change: 1 addition & 0 deletions packages/mui-docs/src/translations/translations.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
"refNotHeld": "The component cannot hold a ref.",
"refRootElement": "The <code>ref</code> is forwarded to the root element.",
"ruleName": "Rule name",
"seeSourceCode": "If you did not find the information in this page, consider having a look at the <a href=\"{{href}}\">implementation of the component</a> for more detail.",
"signature": "Signature",
"slots": "Slots",
"spreadHint": "Props of the {{spreadHintElement}} component are also available.",
Expand Down