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.

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

👩‍💻 Fix SSR styling of code-blocks #480

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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/honest-pumpkins-wink.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@myst-theme/styles': patch
---

Add styling for code-blocks
5 changes: 5 additions & 0 deletions .changeset/shiny-rocks-approve.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'myst-to-react': patch
---

Fix themeing of code-blocks
68 changes: 38 additions & 30 deletions packages/myst-to-react/src/code.tsx
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
import type { NodeRenderer } from '@myst-theme/providers';
import { useThemeSwitcher } from '@myst-theme/providers';
import { LightAsync as SyntaxHighlighter } from 'react-syntax-highlighter';
import light from 'react-syntax-highlighter/dist/esm/styles/hljs/xcode.js';

Check warning on line 3 in packages/myst-to-react/src/code.tsx

View workflow job for this annotation

GitHub Actions / lint

'light' is defined but never used
import dark from 'react-syntax-highlighter/dist/esm/styles/hljs/vs2015.js';

Check warning on line 4 in packages/myst-to-react/src/code.tsx

View workflow job for this annotation

GitHub Actions / lint

'dark' is defined but never used
import { DocumentIcon } from '@heroicons/react/24/outline';
import classNames from 'classnames';
import { CopyIcon } from './components/index.js';
import { MyST } from './MyST.js';
import { useMemo } from 'react';
import type { ComponentProps, CSSProperties } from 'react';

Check warning on line 10 in packages/myst-to-react/src/code.tsx

View workflow job for this annotation

GitHub Actions / lint

'CSSProperties' is defined but never used

type Props = {
value: string;
Expand All @@ -32,8 +33,9 @@
}
}

type HighlightPropsType = ComponentProps<typeof SyntaxHighlighter>;

export function CodeBlock(props: Props) {
const { isLight } = useThemeSwitcher();
agoose77 marked this conversation as resolved.
Show resolved Hide resolved
const {
value,
lang,
Expand All @@ -48,7 +50,39 @@
background,
border,
} = props;
const highlightLines = new Set(emphasizeLines);
const highlighterProps: Omit<HighlightPropsType, 'children'> = useMemo(() => {
const highlightLines = new Set(emphasizeLines);
return {
language: normalizeLanguage(lang),
startingLineNumber,
showLineNumbers,
useInlineStyles: true,
wrapLines: true,
lineNumberContainerStyle: {
// This stops page content shifts
display: 'inline-block',
float: 'left',
minWidth: '1.25em',
paddingRight: '1em',
textAlign: 'right',
userSelect: 'none',
borderLeft: '4px solid transparent',
},
lineProps: (line: number | boolean) => {
if (typeof line === 'boolean') return {};
return highlightLines.has(line)
? ({
'data-line-number': `${line}`,
'data-highlight': 'true',
} as any)
: ({ 'data-line-number': `${line}` } as any);
},
customStyle: {
backgroundColor: 'unset',
},
};
}, [emphasizeLines]);

return (
<div
id={identifier}
Expand All @@ -71,33 +105,7 @@
</div>
</div>
)}
<SyntaxHighlighter
language={normalizeLanguage(lang)}
startingLineNumber={startingLineNumber}
showLineNumbers={showLineNumbers}
style={isLight ? { ...light, hljs: { ...light.hljs, background: 'transparent' } } : dark}
wrapLines
lineNumberContainerStyle={{
// This stops page content shifts
display: 'inline-block',
float: 'left',
minWidth: '1.25em',
paddingRight: '1em',
textAlign: 'right',
userSelect: 'none',
borderLeft: '4px solid transparent',
}}
lineProps={(line) => {
if (typeof line === 'boolean') return {};
return highlightLines.has(line)
? ({
'data-line-number': `${line}`,
'data-highlight': 'true',
} as any)
: ({ 'data-line-number': `${line}` } as any);
}}
customStyle={{ padding: '0.8rem' }}
>
<SyntaxHighlighter {...highlighterProps} className="block hljs">
{value}
</SyntaxHighlighter>
{showCopy && (
Expand Down
2 changes: 2 additions & 0 deletions styles/app.css
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
@import './figures.css';
@import './text-spacers.css';
@import './code-highlight.css';
@import './code-highlight-dark.css';
@import './code-highlight-light.css';
@import './math.css';
@import './cross-references.css';
@import './block-styles.css';
Expand Down
146 changes: 146 additions & 0 deletions styles/code-highlight-dark.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
/*
BSD 3-Clause License

Copyright (c) 2006, Ivan Sagalaev.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


Visual Studio 2015 dark style
Author: Nicolas LLOBERA <[email protected]>
*/

.dark .hljs {
background: #1e1e1e !important;
color: #dcdcdc;
}

.dark .hljs-keyword,
.dark .hljs-literal,
.dark .hljs-symbol,
.dark .hljs-name {
color: #569cd6;
}
.dark .hljs-link {
color: #569cd6;
text-decoration: underline;
}

.dark .hljs-built_in,
.dark .hljs-type {
color: #4ec9b0;
}

.dark .hljs-number,
.dark .hljs-class {
color: #b8d7a3;
}

.dark .hljs-string,
.dark .hljs-meta .hljs-string {
color: #d69d85;
}

.dark .hljs-regexp,
.dark .hljs-template-tag {
color: #9a5334;
}

.dark .hljs-subst,
.dark .hljs-function,
.dark .hljs-title,
.dark .hljs-params,
.dark .hljs-formula {
color: #dcdcdc;
}

.dark .hljs-comment,
.dark .hljs-quote {
color: #57a64a;
font-style: italic;
}

.dark .hljs-doctag {
color: #608b4e;
}

.dark .hljs-meta,
.dark .hljs-meta .hljs-keyword,
.dark .hljs-tag {
color: #9b9b9b;
}

.dark .hljs-variable,
.dark .hljs-template-variable {
color: #bd63c5;
}

.dark .hljs-attr,
.dark .hljs-attribute {
color: #9cdcfe;
}

.dark .hljs-section {
color: gold;
}

.dark .hljs-emphasis {
font-style: italic;
}

.dark .hljs-strong {
font-weight: bold;
}

/*.hljs-code {
font-family:'Monospace';
}*/

.dark .hljs-bullet,
.dark .hljs-selector-tag,
.dark .hljs-selector-id,
.dark .hljs-selector-class,
.dark .hljs-selector-attr,
.dark .hljs-selector-pseudo {
color: #d7ba7d;
}

.dark .hljs-addition {
background-color: #144212;
display: inline-block;
width: 100%;
}

.dark .hljs-deletion {
background-color: #600;
display: inline-block;
width: 100%;
}

.dark .hljs-code {
color: unset;
}
124 changes: 124 additions & 0 deletions styles/code-highlight-light.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
/*
BSD 3-Clause License

Copyright (c) 2006, Ivan Sagalaev.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

XCode style (c) Angel Garcia <[email protected]>
*/

/* Gray DOCTYPE selectors like WebKit */
.xml .hljs-meta {
color: #c0c0c0;
background: transparent;
}

.hljs-comment,
.hljs-quote {
color: #007400;
}

.hljs-tag,
.hljs-attribute,
.hljs-keyword,
.hljs-selector-tag,
.hljs-literal,
.hljs-name {
color: #aa0d91;
}

.hljs-variable,
.hljs-template-variable {
color: #3f6e74;
}

.hljs-code,
.hljs-string,
.hljs-meta .hljs-string {
color: #c41a16;
}

.hljs-regexp,
.hljs-link {
color: #0e0eff;
}

.hljs-title,
.hljs-symbol,
.hljs-bullet,
.hljs-number {
color: #1c00cf;
}

.hljs-section,
.hljs-meta {
color: #643820;
}

.hljs-title.class_,
.hljs-class .hljs-title,
.hljs-type,
.hljs-built_in,
.hljs-params {
color: #5c2699;
}

.hljs-attr {
color: #836c28;
}

.hljs-subst {
color: #000;
}

.hljs-formula {
background-color: #eee;
font-style: italic;
}

.hljs-addition {
background-color: #baeeba;
}

.hljs-deletion {
background-color: #ffc8bd;
}

.hljs-selector-id,
.hljs-selector-class {
color: #9b703f;
}

.hljs-doctag,
.hljs-strong {
font-weight: bold;
}

.hljs-emphasis {
font-style: italic;
}
Loading