Skip to content

Commit 0863c4f

Browse files
committed
update astro to v2 and use content collections for docs
1 parent b5e4589 commit 0863c4f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+245
-72
lines changed

.eslintrc.js

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ module.exports = {
1313
plugins: ["@typescript-eslint", "prettier"],
1414
rules: {
1515
"no-unused-expressions": "off",
16+
"@typescript-eslint/triple-slash-reference": "off",
1617
"prettier/prettier": [2],
1718
},
1819
}

.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,6 @@ typechain-types/
3636
.temp*
3737

3838
.cache
39-
.vscode
39+
.vscode
40+
41+
.astro/

astro-i18next.config.ts

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
/** @type {import('astro-i18next').AstroI18nextConfig} */
22
export default {
33
defaultLocale: "en",
4+
showDefaultLocale: true,
45
locales: ["en", "zh"],
56
}

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
"@types/github-slugger": "^1.3.0",
5656
"@typescript-eslint/eslint-plugin": "^5.43.0",
5757
"@typescript-eslint/parser": "^5.43.0",
58-
"astro": "^1.6.8",
58+
"astro": "^2.4.4",
5959
"dart-linkcheck": "^2.0.15",
6060
"dotenv": "^16.0.3",
6161
"eslint": "^8.27.0",

public/locales/en/translation.json

+3
Original file line numberDiff line numberDiff line change
@@ -83,5 +83,8 @@
8383
"infrastructure": {
8484
"introduction": "Introduction"
8585
}
86+
},
87+
"notTranslated": {
88+
"notTranslated": "This page has not been translated yet."
8689
}
8790
}

public/locales/zh/translation.json

+3
Original file line numberDiff line numberDiff line change
@@ -83,5 +83,8 @@
8383
"infrastructure": {
8484
"introduction": "介绍"
8585
}
86+
},
87+
"notTranslated": {
88+
"notTranslated": "此页面尚未翻译。"
8689
}
8790
}

src/components/LeftSidebar/LeftSidebar.astro

+6-4
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@ const currentPageMatch = removeSlashes(currentPage.slice(1))
5858
<>
5959
<li class="nav-link">
6060
<a
61-
href={isExternal(child.url) ? `${child.url}` : localizePath(child.url)}
61+
href={isExternal(child.url) ? `${child.url}` : localizePath("/docs/" + child.url)}
6262
target={isExternal(child.url) ? "_blank" : "_self"}
63-
aria-current={`${currentPage === localizePath(child.url) ? "page" : "false"}`}
63+
aria-current={`${currentPage === localizePath("/docs/" + child.url) ? "page" : "false"}`}
6464
>
6565
{child.title}
6666
{isExternal(child.url) && (
@@ -77,9 +77,11 @@ const currentPageMatch = removeSlashes(currentPage.slice(1))
7777
{child.children.map((childItem) => (
7878
<li class="nav-link nested">
7979
<a
80-
href={isExternal(childItem.url) ? childItem.url : localizePath(childItem.url)}
80+
href={isExternal(childItem.url) ? childItem.url : localizePath("/docs/" + childItem.url)}
8181
target={isExternal(child.url) ? "_blank" : "_self"}
82-
aria-current={`${currentPage === localizePath(childItem.url) ? "page" : "false"}`}
82+
aria-current={`${
83+
currentPage === localizePath("/docs/" + childItem.url) ? "page" : "false"
84+
}`}
8385
>
8486
{childItem.title}
8587
{isExternal(childItem.url) && (

src/config/menu.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,21 @@ export const MENU: MenuItems = {
1010
en: [
1111
{
1212
text: "Getting Started",
13-
link: "/getting-started/overview",
13+
link: "/en/docs/getting-started/overview",
1414
section: "gettingStarted",
1515
},
16-
{ text: "Developers", link: "/developers", section: "developers" },
17-
{ text: "Technology", link: "/technology", section: "technology" },
18-
{ text: "Learn", link: "/learn", section: "learn" },
16+
{ text: "Developers", link: "/en/docs/developers", section: "developers" },
17+
{ text: "Technology", link: "/en/docs/technology", section: "technology" },
18+
{ text: "Learn", link: "/en/docs/learn", section: "learn" },
1919
],
2020
zh: [
2121
{
2222
text: "入门",
23-
link: "/zh/getting-started/overview",
23+
link: "/zh/docs/getting-started/overview",
2424
section: "gettingStarted",
2525
},
26-
{ text: "开发者", link: "/zh/developers", section: "developers" },
27-
{ text: "技术", link: "/zh/technology", section: "technology" },
28-
{ text: "学习", link: "/zh/learn", section: "learn" },
26+
{ text: "开发者", link: "/zh/docs/developers", section: "developers" },
27+
{ text: "技术", link: "/zh/docs/technology", section: "technology" },
28+
{ text: "学习", link: "/zh/docs/learn", section: "learn" },
2929
],
3030
}

src/content/config.ts

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import { defineCollection, z } from "astro:content"
2+
3+
const docsCollection = defineCollection({
4+
schema: z.object({
5+
title: z.string(),
6+
section: z.string(),
7+
}),
8+
})
9+
10+
export const collections = {
11+
docs: docsCollection,
12+
}

src/pages/developers/alpha-testnet-contracts.md renamed to src/content/docs/en/developers/alpha-testnet-contracts.md

-1

src/pages/developers/developer-quickstart.md renamed to src/content/docs/en/developers/developer-quickstart.md

-1

src/pages/developers/ethereum-and-alpha-testnet-differences.md renamed to src/content/docs/en/developers/ethereum-and-alpha-testnet-differences.md

-1

src/pages/developers/guides/contract-deployment-tutorial.md renamed to src/content/docs/en/developers/guides/contract-deployment-tutorial.md

-1

src/pages/developers/index.mdx renamed to src/content/docs/en/developers/index.mdx

-1

src/pages/developers/integrations.md renamed to src/content/docs/en/developers/integrations.md

-1

src/pages/getting-started/overview.md renamed to src/content/docs/en/getting-started/overview.md

-1

src/pages/learn/index.mdx renamed to src/content/docs/en/learn/index.mdx

+4-5

src/pages/technology/index.mdx renamed to src/content/docs/en/technology/index.mdx

-1

src/pages/user-guide/bridge.mdx renamed to src/content/docs/en/user-guide/bridge.mdx

+1-2

src/pages/user-guide/common-errors.md renamed to src/content/docs/en/user-guide/common-errors.md

-1

src/pages/user-guide/faucet.md renamed to src/content/docs/en/user-guide/faucet.md

-1

src/pages/user-guide/index.md renamed to src/content/docs/en/user-guide/index.md

-1

src/pages/user-guide/setup.md renamed to src/content/docs/en/user-guide/setup.md

-1

src/pages/user-guide/transfer-tokens.md renamed to src/content/docs/en/user-guide/transfer-tokens.md

-1

src/pages/zh/developers/alpha-testnet-contracts.md renamed to src/content/docs/zh/developers/alpha-testnet-contracts.md

-1

src/pages/zh/developers/developer-quickstart.md renamed to src/content/docs/zh/developers/developer-quickstart.md

-1

src/pages/zh/developers/ethereum-and-alpha-testnet-differences.md renamed to src/content/docs/zh/developers/ethereum-and-alpha-testnet-differences.md

-1

src/pages/zh/developers/guides/contract-deployment-tutorial.md renamed to src/content/docs/zh/developers/guides/contract-deployment-tutorial.md

-1

src/pages/zh/developers/index.mdx renamed to src/content/docs/zh/developers/index.mdx

-1

src/pages/zh/developers/integrations.md renamed to src/content/docs/zh/developers/integrations.md

-1

src/pages/zh/getting-started/overview.md renamed to src/content/docs/zh/getting-started/overview.md

-1

src/pages/zh/learn/index.mdx renamed to src/content/docs/zh/learn/index.mdx

+4-5

src/pages/zh/user-guide/bridge.mdx renamed to src/content/docs/zh/user-guide/bridge.mdx

+1-2

src/pages/zh/user-guide/common-errors.md renamed to src/content/docs/zh/user-guide/common-errors.md

-1

src/pages/zh/user-guide/faucet.md renamed to src/content/docs/zh/user-guide/faucet.md

-1

src/pages/zh/user-guide/index.md renamed to src/content/docs/zh/user-guide/index.md

-1

src/pages/zh/user-guide/setup.md renamed to src/content/docs/zh/user-guide/setup.md

-1

src/pages/zh/user-guide/transfer-tokens.md renamed to src/content/docs/zh/user-guide/transfer-tokens.md

-1

src/env.d.ts

+1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1+
/// <reference path="../.astro/types.d.ts" />
12
/// <reference types="@astrojs/image/client" />

0 commit comments

Comments
 (0)