-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
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
feat(theme-classic): syntax-highlighting for inline code #8717
Open
zepatrik
wants to merge
3
commits into
facebook:main
Choose a base branch
from
zepatrik:feat/inline-code-highlight
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
65 changes: 65 additions & 0 deletions
65
packages/docusaurus-theme-classic/src/theme/CodeInline/index.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
/** | ||
* Copyright (c) Facebook, Inc. and its affiliates. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
*/ | ||
|
||
import React from 'react'; | ||
import clsx from 'clsx'; | ||
import {usePrismTheme, useThemeConfig} from '@docusaurus/theme-common'; | ||
import Highlight, {defaultProps, type Language} from 'prism-react-renderer'; | ||
import type {Props} from '@theme/CodeInline'; | ||
|
||
export default function CodeInline({ | ||
language: languageProp, | ||
className = '', | ||
children, | ||
}: Props): JSX.Element { | ||
const { | ||
prism: {defaultLanguage}, | ||
} = useThemeConfig(); | ||
const language = languageProp ?? defaultLanguage ?? 'text'; | ||
const prismTheme = usePrismTheme(); | ||
|
||
if (!children || typeof children !== 'string') { | ||
return <code className={className}>{children}</code>; | ||
} | ||
|
||
return ( | ||
<Highlight | ||
{...defaultProps} | ||
theme={prismTheme} | ||
code={children} | ||
language={language as Language}> | ||
{({ | ||
className: highlightClassName, | ||
tokens, | ||
getLineProps, | ||
getTokenProps, | ||
}) => { | ||
if (tokens.length !== 1) { | ||
// This is actually multi-line (or empty) code. | ||
// Multi-line _should_ never happen. | ||
// Just return the code without highlighting I guess? | ||
return children; | ||
} | ||
return ( | ||
<code | ||
{...getLineProps({ | ||
line: tokens[0]!, | ||
className: clsx( | ||
className, | ||
`language-${language}`, | ||
highlightClassName, | ||
), | ||
})}> | ||
{tokens[0]!.map((token, key) => ( | ||
<span key={key} {...getTokenProps({token})} /> | ||
))} | ||
</code> | ||
); | ||
}} | ||
</Highlight> | ||
); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is also the worst-case fallback in the
CodeBlock
.