Skip to content

Commit

Permalink
Merge pull request #302 from scroll-tech/develop
Browse files Browse the repository at this point in the history
Dev Tooling page
  • Loading branch information
dghelm authored Aug 5, 2024
2 parents 4071770 + c7f3925 commit 213805a
Show file tree
Hide file tree
Showing 76 changed files with 1,874 additions and 393 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,24 @@ npm install && npm run dev
- All articles are markdown and stored in `/src/content/docs/`.
- Navigation is JSON in `/src/config/sidebar.ts`

## Tooling on Scroll

If you'd like to add an entry to our [tooling list](http://docs.scroll.xyz/en/developers/scroll-contracts), create a PR to add a new `mdx` file in the [tooling content folder](src/content/tools), using the following template. You can also refer to other existing entries for reference.

```
---
name: "Safe"
category: ["Identity", "Wallet"]
excerpt: "Safe allows you to create smart wallet on chain."
logo: { src: "https://app.safe.global/images/safe-logo-green.png", alt: "Safe Logo" }
website: "https://app.safe.global"
network: ["Mainnet", "Testnet]
noAdditionalInfo: false
---
Add additional info here about how to access this tool on Scroll (ex. contract addresses, tutorials, API URLs)
```

## Credits

- Special thanks to the Chainlink team whose documentation we forked. Their repo is available [here](https://github.com/smartcontractkit/documentation) and viewable at [https://docs.chain.link/](https://docs.chain.link/).
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
2 changes: 2 additions & 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 All @@ -42,6 +43,7 @@
"query-string": "^7.1.1",
"react-instantsearch-hooks-web": "^6.38.1",
"react-mailchimp-subscribe": "^2.1.3",
"rehype-format": "^5.0.0",
"rehype-katex": "^7.0.0",
"rehype-mermaidjs": "^1.0.1",
"remark-gfm": "^4.0.0",
Expand Down
3 changes: 3 additions & 0 deletions public/assets/github-white-800.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions public/locales/en/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@
"erc1155TokenBridge": "ERC1155 Token Bridge",
"theScrollMessenger": "The Scroll Messenger",
"transactionFeesOnScroll": "Transaction Fees on Scroll",
"toolingDeployedOnScroll": "Tooling deployed On Scroll",
"l2Fee": "L2 Fee",
"l1Fee": "L1 Fee",
"gasOracle": "Gas Oracle",
Expand Down
25 changes: 25 additions & 0 deletions public/scroll-docs-white-800.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/assets/svgs/header/sun.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions src/assets/svgs/home/Note.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/components/Aside.astro
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const icons = {

<aside class={`content ${type}`} aria-label={title}>
<div class="icon">
<span class="inline-block w-[1.5rem] h-[1.5rem] text-black dark:text-white">
<span class="inline-block w-[1.5rem] h-[1.5rem] text-black dark:text-white-800">
<Fragment set:html={icons[type]} />
</span>
</div>
Expand Down
4 changes: 2 additions & 2 deletions src/components/Footer/Subscribe/EmailInput.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ const EmailInput = (props) => {
onKeyDown={handleEnter}
className={clsx(
styles.inputBase,
"dark:text-white",
"dark:text-white-800",
"dark:bg-black",
"dark:border-white",
"dark:border-white-800",
"placeholder:text-[#dcdcdc]",
"placeholder:dark:text-[#FFF8F366]",
"focus:outline-none"
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
Loading

0 comments on commit 213805a

Please sign in to comment.