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

Syntax Highlighting #304

Merged
merged 2 commits into from
Jul 22, 2024
Merged
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
17 changes: 17 additions & 0 deletions astro.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ import sitemap from "@astrojs/sitemap"

import tailwind from "@astrojs/tailwind"

import expressiveCode from "astro-expressive-code"

// https://astro.build/config
export default defineConfig({
site: "https://docs.scroll.io",
Expand All @@ -38,6 +40,21 @@ export default defineConfig({
}),
astroCallouts(),
solidityRemixCode(),
expressiveCode({
themes: ["dark-plus"],
defaultProps: {
frame: "code",
},
styleOverrides: {
borderRadius: "27px",
borderColor: "transparent",
frames: {
shadowColor: "transparent",
editorTabBorderRadius: "0.5rem",
editorBackground: "#2b2b2b",
},
},
}),
mdx(),
tailwind({
applyBaseStyles: false,
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
"@astrojs/tailwind": "^5.1.0",
"@nanostores/preact": "^0.3.1",
"astro-auto-import": "^0.4.2",
"astro-expressive-code": "^0.35.3",
"astro-i18next": "^1.0.0-beta.21",
"clipboard": "^2.0.11",
"ethereum-rpc-table": "^0.0.1",
Expand Down
1 change: 0 additions & 1 deletion src/components/HeadCommon.astro
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ import "../styles/theme.css"
import "../styles/index.css"
import "../styles/migrated.css"
import "../styles/prism-darcula.css"
import "../styles/copy-to-clipboard.css"

import "../styles/design-system/global-styles.css"
---
Expand Down
2 changes: 2 additions & 0 deletions src/components/LeftSidebar/LeftSidebar.astro
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,8 @@ const processedSidebarSections = sidebarSections.map((section) => {

.nav-link.open + ul {
display: block;
border-left-width: 1px;
border-left-style: solid;
}

.nested {
Expand Down
52 changes: 52 additions & 0 deletions src/content/docs/en/article-components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,58 @@ Let's see a horizontal rule.

We define the Square-Fibonacci sequence[^1], a variation of the Fibonacci sequence:

### Syntax Highlighting

```js {13-15}
...

const config: HardhatUserConfig = {
...
networks: {
scrollSepolia: {
url: 'https://sepolia-rpc.scroll.io' || '',
accounts:
process.env.PRIVATE_KEY !== undefined ? [process.env.PRIVATE_KEY] : [],
},
},
etherscan: {
apiKey: {
scrollSepolia: <YOUR API KEY>,
},
customChains: [
{
network: 'scrollSepolia',
chainId: 534351,
urls: {
apiURL: 'https://api-sepolia.scrollscan.com/api',
browserURL: 'https://sepolia.scrollscan.com/',
},
},
],
},
}

...
```

```js "return true;" ins="inserted" del="deleted"
function demo() {
console.log('These are inserted and deleted marker types');
// The return statement uses the default marker type
return true;
}
```

```diff lang="js"
function thisIsJavaScript() {
// This entire block gets highlighted as JavaScript,
// and we can still add diff markers to it!
- console.log('Old code to be removed')
+ console.log('New and shiny code!')
}
```


### Math

- Let $f_0 = 1, f_1 = 1$
Expand Down
35 changes: 0 additions & 35 deletions src/scripts/copy-to-clipboard.ts

This file was deleted.

11 changes: 11 additions & 0 deletions src/scripts/has-focused-lines.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
document.addEventListener("DOMContentLoaded", function () {
document.addEventListener("astro:page-load", () => {
const preElements = document.querySelectorAll(".expressive-code")
preElements.forEach((pre) => {
const hasTargetClass = pre.querySelector(".mark")
if (hasTargetClass) {
pre.classList.add("has-focused-lines")
}
})
})
})
2 changes: 1 addition & 1 deletion src/scripts/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import "./fix-remix-urls"
import "./fix-external-links"
import "./click-to-zoom"
import "./copy-to-clipboard"
import "./has-focused-lines"
22 changes: 0 additions & 22 deletions src/styles/copy-to-clipboard.css

This file was deleted.

141 changes: 32 additions & 109 deletions src/styles/prism-darcula.css
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
/**
* Darcula theme
*
* Adapted from a theme based on:
* IntelliJ Darcula Theme (https://github.com/bulenkov/Darcula)
*
* @author Alexandre Paradis <[email protected]>
* @version 1.0
*/

code[class*="language-"],
pre[class*="language-"] {
code[data-language],
pre[data-language] {
color: #a9b7c6;
font-family: var(--font-family-code);
direction: ltr;
Expand All @@ -30,142 +20,75 @@ pre[class*="language-"] {
}

code,
code[class*="language-"] *,
pre[class*="language-"] * {
code[data-language] *,
pre[data-language] * {
font-family: var(--font-family-code) !important;
font-size: 16px;
}

pre[class*="language-"]::-moz-selection,
pre[class*="language-"] ::-moz-selection,
code[class*="language-"]::-moz-selection,
code[class*="language-"] ::-moz-selection {
pre[data-language]::-moz-selection,
pre[data-language] ::-moz-selection,
code[data-language]::-moz-selection,
code[data-language] ::-moz-selection {
color: inherit;
background: rgba(33, 66, 131, 0.85);
}

/* Code blocks */
pre[class*="language-"] {
pre[data-language] {
padding: 1em;
margin: 0.5em 0;
overflow: auto;
margin-top: 1.4em;
margin-bottom: 2.2em;
}

:not(pre) > code[class*="language-"],
pre[class*="language-"] {
:not(pre) > code[data-language],
pre[data-language] {
background: #2b2b2b;
border-radius: 27px;
padding: 17px;
padding-right: 70px;
}

/* Inline code */
:not(pre) > code[class*="language-"] {
:not(pre) > code[data-language] {
padding: 0.1em;
border-radius: 0.3em;
}

.token.class-name {
color: #afafaf;
}

.token.comment,
.token.prolog,
.token.cdata {
color: #808080;
}

.token.delimiter,
.token.boolean,
.token.keyword,
.token.selector,
.token.important,
.token.atrule {
color: #cc7832;
}

.token.operator,
.token.punctuation,
.token.attr-name {
color: #a9b7c6;
}

.token.tag,
.token.tag .punctuation,
.token.doctype,
.token.builtin {
color: #e8bf6a;
}

.token.entity,
.token.number,
.token.symbol {
color: #6897bb;
}

.token.property,
.token.constant,
.token.variable {
color: #9876aa;
.frame {
overflow: hidden;
}

.token.string,
.token.char {
color: #6a8759;
.expressive-code pre,
.expressive-code code {
font-size: 16px !important;
}

.token.attr-value,
.token.attr-value .punctuation {
color: #a5c261;
.expressive-code.has-focused-lines .ec-line:not(.highlight) .code {
opacity: 0.7;
transition: filter 0.35s, opacity 0.35s;
filter: blur(0.095rem);
}

.token.attr-value .punctuation:first-child {
color: #a9b7c6;
}

.token.url {
color: #287bde;
text-decoration: underline;
}

.token.function {
color: #ffc66d;
}

.token.regex {
background: #364135;
.expressive-code.has-focused-lines:hover .ec-line .code {
opacity: 1;
filter: none;
}

.token.bold {
font-weight: bold;
.expressive-code.has-focused-lines .ec-line.mark.highlight {
background: transparent;
}

.token.italic {
font-style: italic;
}

.token.inserted {
background: #294436;
}

.token.deleted {
background: #484a4a;
}

code.language-css .token.property,
code.language-css .token.property + .token.punctuation {
color: #a9b7c6;
.expressive-code div.copy button {
border-radius: 50%;
}

code.language-css .token.id {
color: #ffc66d;
div.expressive-code pre::-webkit-scrollbar {
height: 0;
}

code.language-css .token.selector > .token.class,
code.language-css .token.selector > .token.attribute,
code.language-css .token.selector > .token.pseudo-class,
code.language-css .token.selector > .token.pseudo-element {
color: #ffc66d;
.expressive-code .ec-line div.code {
border-inline-start: unset;
}