diff --git a/.github/workflows/deploy-prod.yml b/.github/workflows/deploy-prod.yml index a6220bd87a0..3e74b6e9c66 100644 --- a/.github/workflows/deploy-prod.yml +++ b/.github/workflows/deploy-prod.yml @@ -9,20 +9,31 @@ jobs: build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 - - uses: actions/setup-node@v3 + - name: Checkout + uses: actions/checkout@v4 + + - name: Install pnpm + uses: pnpm/action-setup@v2 + with: + run_install: true + + - name: Setup Node.js + uses: actions/setup-node@v4 with: - # choose node.js version to use - node-version: 16 - - run: npm install -g yarn - - run: yarn install - - run: yarn docs:build + node-version: 20 + cache: pnpm + + - name: Build docs + run: pnpm docs:build + - uses: aws-actions/configure-aws-credentials@v1 with: aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} aws-region: ap-northeast-1 + - run: aws s3 sync ./docs/.vuepress/dist s3://doc.subquery.network/ --delete + - name: Invalidate CloudFront uses: chetan/invalidate-cloudfront-action@v2 env: diff --git a/.github/workflows/deploy-staging.yml b/.github/workflows/deploy-staging.yml index c2cff5c5eb3..7f6b18ca3e3 100644 --- a/.github/workflows/deploy-staging.yml +++ b/.github/workflows/deploy-staging.yml @@ -11,14 +11,23 @@ jobs: build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 - - uses: actions/setup-node@v3 + - name: Checkout + uses: actions/checkout@v4 + + - name: Install pnpm + uses: pnpm/action-setup@v2 + with: + run_install: true + + - name: Setup Node.js + uses: actions/setup-node@v4 with: - # choose node.js version to use - node-version: 16 - - run: npm install -g yarn - - run: yarn install - - run: yarn docs:build + node-version: 20 + cache: pnpm + + - name: Build docs + run: pnpm docs:build + - uses: aws-actions/configure-aws-credentials@v1 with: aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index dffde7cb029..948f2216ff2 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -11,10 +11,19 @@ jobs: build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - uses: actions/setup-node@v1 + - name: Checkout + uses: actions/checkout@v4 + + - name: Install pnpm + uses: pnpm/action-setup@v2 + with: + run_install: true + + - name: Setup Node.js + uses: actions/setup-node@v4 with: - node-version: 16 - - run: npm install -g yarn - - run: yarn install - - run: yarn docs:build + node-version: 20 + cache: pnpm + + - name: Build docs + run: pnpm docs:build diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts index a14bfd7ff0f..b6d579e4a81 100644 --- a/docs/.vuepress/config.ts +++ b/docs/.vuepress/config.ts @@ -1,95 +1,16 @@ import { defineUserConfig } from "vuepress"; -import { hopeTheme, SidebarOptions } from "vuepress-theme-hope"; +import { hopeTheme } from "vuepress-theme-hope"; import { googleAnalyticsPlugin } from "@vuepress/plugin-google-analytics"; -import { sitemapPlugin } from "vuepress-plugin-sitemap2"; import { docsearchPlugin } from "@vuepress/plugin-docsearch"; -import { seoPlugin } from "vuepress-plugin-seo2"; import { redirectPlugin } from "vuepress-plugin-redirect"; - -const hostname = "https://academy.subquery.network"; +import { getSidebar } from "./sidebar"; export default defineUserConfig({ - plugins: [ - googleAnalyticsPlugin({ - id: "G-MY90N76MNK", - }), - seoPlugin({ - hostname, - author: { - name: "SubQuery Team", - }, - autoDescription: true, - twitterID: "@SubQueryNetwork", - fallBackImage: "https://static.subquery.network/link-share.jpg", - }), - sitemapPlugin({ - hostname, - }), - docsearchPlugin({ - appId: "30B5W460WL", - apiKey: "fdae5afc6c3711a8b4f53a4801b43143", - indexName: "subquery_academy", - }), - redirectPlugin({ - config: { - "/subquery_network/architects.html": - "/subquery_network/architects/introduction.html", - "/subquery_network/consumers.html": - "/subquery_network/consumers/introduction.html", - "/subquery_network/delegators.html": - "/subquery_network/delegators/introduction.html", - "/subquery_network/indexers.html": - "/subquery_network/indexers/introduction.html", - "/subquery_network/token.html": "/subquery_network/token/token.html", - "/subquery_network/design-philosophy.html": - "/subquery_network/design/design-philosophy.html", - "/subquery_network/payment-methods.html": - "/subquery_network/design/payment-methods.html", - "/subquery_network/kepler/welcome.html": - "/subquery_network/introduction.html", - "/subquery_network/kepler/ksqt.html": - "/subquery_network/token/token.html", - "/subquery_network/kepler/indexers/become-an-indexer.html": - "/subquery_network/indexers/become-an-indexer.html", - "/subquery_network/kepler/indexers/install-indexer-locally.html": - "/subquery_network/indexers/install-indexer-locally.html", - "/subquery_network/kepler/indexers/install-indexer-linux.html": - "/subquery_network/indexers/install-indexer-linux.html", - "/subquery_network/kepler/indexers/index-project.html": - "/subquery_network/indexers/index-project.html", - "/subquery_network/kepler/indexers/dictionary-restore.html": - "/subquery_network/indexers/dictionary-restore.html", - "/subquery_network/kepler/indexers/plans.html": - "/subquery_network/indexers/plans.html", - "/subquery_network/kepler/indexers/troubleshooting-indexers.html": - "/subquery_network/indexers/troubleshooting-indexers.html", - "/subquery_network/kepler/indexers/faqs-indexers.html": - "/subquery_network/indexers/faqs-indexers.html", - "/subquery_network/kepler/indexers/ssl-configuration.html": - "/subquery_network/indexers/indexer-security-guide.html", - "/subquery_network/indexers/ssl-configuration.html": - "/subquery_network/indexers/indexer-security-guide.html", - "/build/manifest/terra.html": "/build/manifest/cosmos.html", - "/build/mapping/terra.html": "/build/mapping/cosmos.html", - "/build/quickstart/quickstart_chains/terra.html": - "/build/quickstart/quickstart_chains/cosmos.html", - "/run_publish/ipfs.html": "/miscellaneous/ipfs.html", - }, - }), - ], title: "SubQuery Academy (Documentation)", description: "Learn how to build with SubQuery. SubQuery is a fast, flexible, and reliable open-source data indexer that provides you with custom APIs for your web3 project. Build your API anywhere across multiple chains in minutes with our open-source SDK.", head: [ ["link", { rel: "icon", href: "/assets/img/logo.png" }], - [ - "link", - { - rel: "icon", - href: "/assets/favicons/favicon.ico", - type: "image/x-icon", - }, - ], [ "link", { @@ -117,8 +38,8 @@ export default defineUserConfig({ href: "/assets/favicons/favicon-16x16.png", }, ], - ["link", { rel: "manifest", href: "/assets/manifest.json" }], ], + locales: { "/": { lang: "en-US", @@ -126,151 +47,133 @@ export default defineUserConfig({ description: "Explore and transform your chain data to build intuitive dApps faster!", }, - /* - "/zh/": { - lang: "zh-CN", - title: "SubQuery Academy (Documentation)", - description: - "Explore and transform your chain data to build intuitive dApps faster!.", - }, - "/es/": { - lang: "es", - title: "SubQuery Academy (Documentation)", - description: - "Explore and transform your chain data to build intuitive dApps faster!.", - }, - "/de/": { - lang: "de-AT", - title: "SubQuery Academy (Documentation)", - description: - "Explore and transform your chain data to build intuitive dApps faster!.", - }, - /* - "/id/": { - lang: "id", - title: "SubQuery Academy (Documentation)", - description: - "Explore and transform your chain data to build intuitive dApps faster!.", - }, - "/it/": { - lang: "it", - title: "SubQuery Academy (Documentation)", - description: - "Explore and transform your chain data to build intuitive dApps faster!.", - }, - "/ja/": { - lang: "ja", - title: "SubQuery Academy (Documentation)", - description: - "Explore and transform your chain data to build intuitive dApps faster!.", - }, - "/ko/": { - lang: "ko", - title: "SubQuery Academy (Documentation)", - description: - "Explore and transform your chain data to build intuitive dApps faster!.", - }, - "/ru/": { - lang: "ru", - title: "SubQuery Academy (Documentation)", - description: - "Explore and transform your chain data to build intuitive dApps faster!.", - }, - "/th/": { - lang: "th", - title: "SubQuery Academy (Documentation)", - description: - "Explore and transform your chain data to build intuitive dApps faster!.", - }, - "/tr/": { - lang: "tr", - title: "SubQuery Academy (Documentation)", - description: - "Explore and transform your chain data to build intuitive dApps faster!.", - }, - "/uk/": { - lang: "uk", - title: "SubQuery Academy (Documentation)", - description: - "Explore and transform your chain data to build intuitive dApps faster!.", - }, - "/vi/": { - lang: "vi", - title: "SubQuery Academy (Documentation)", - description: - "Explore and transform your chain data to build intuitive dApps faster!.", - }, - */ + + // "/zh/": { + // lang: "zh-CN", + // title: "SubQuery Academy (Documentation)", + // description: + // "Explore and transform your chain data to build intuitive dApps faster!.", + // }, + // "/es/": { + // lang: "es", + // title: "SubQuery Academy (Documentation)", + // description: + // "Explore and transform your chain data to build intuitive dApps faster!.", + // }, + // "/de/": { + // lang: "de-AT", + // title: "SubQuery Academy (Documentation)", + // description: + // "Explore and transform your chain data to build intuitive dApps faster!.", + // }, + // "/id/": { + // lang: "id", + // title: "SubQuery Academy (Documentation)", + // description: + // "Explore and transform your chain data to build intuitive dApps faster!.", + // }, + // "/it/": { + // lang: "it", + // title: "SubQuery Academy (Documentation)", + // description: + // "Explore and transform your chain data to build intuitive dApps faster!.", + // }, + // "/ja/": { + // lang: "ja", + // title: "SubQuery Academy (Documentation)", + // description: + // "Explore and transform your chain data to build intuitive dApps faster!.", + // }, + // "/ko/": { + // lang: "ko", + // title: "SubQuery Academy (Documentation)", + // description: + // "Explore and transform your chain data to build intuitive dApps faster!.", + // }, + // "/ru/": { + // lang: "ru", + // title: "SubQuery Academy (Documentation)", + // description: + // "Explore and transform your chain data to build intuitive dApps faster!.", + // }, + // "/th/": { + // lang: "th", + // title: "SubQuery Academy (Documentation)", + // description: + // "Explore and transform your chain data to build intuitive dApps faster!.", + // }, + // "/tr/": { + // lang: "tr", + // title: "SubQuery Academy (Documentation)", + // description: + // "Explore and transform your chain data to build intuitive dApps faster!.", + // }, + // "/uk/": { + // lang: "uk", + // title: "SubQuery Academy (Documentation)", + // description: + // "Explore and transform your chain data to build intuitive dApps faster!.", + // }, + // "/vi/": { + // lang: "vi", + // title: "SubQuery Academy (Documentation)", + // description: + // "Explore and transform your chain data to build intuitive dApps faster!.", + // }, }, theme: hopeTheme({ - hostname, + hostname: "https://academy.subquery.network", + favicon: "/assets/favicons/favicon.ico", author: "SubQuery Team", - lastUpdated: true, + locales: { "/": { sidebar: getSidebar(""), }, - /* - "/de/": { - sidebar: getSidebar("/de"), - }, - "/tr/": { - sidebar: getSidebar("/tr"), - }, - "/zh/": { - sidebar: getSidebar("/zh"), - }, - "/vi/": { - sidebar: getSidebar("/vi"), - }, - "/ru/": { - sidebar: getSidebar("/ru"), - }, - "/uk/": { - sidebar: getSidebar("/uk"), - }, - "/es/": { - sidebar: getSidebar("/es"), - }, - "/ja/": { - sidebar: getSidebar("/js"), - }, - "/ko/": { - sidebar: getSidebar("/ko"), - }, - /* - "/id/": { - sidebar: getSidebar("/id"), - }, - "/it/": { - sidebar: getSidebar("/it"), - }, - "/th/": { - sidebar: getSidebar("/th"), - }, - */ + + // "/de/": { + // sidebar: getSidebar("/de"), + // }, + // "/tr/": { + // sidebar: getSidebar("/tr"), + // }, + // "/zh/": { + // sidebar: getSidebar("/zh"), + // }, + // "/vi/": { + // sidebar: getSidebar("/vi"), + // }, + // "/ru/": { + // sidebar: getSidebar("/ru"), + // }, + // "/uk/": { + // sidebar: getSidebar("/uk"), + // }, + // "/es/": { + // sidebar: getSidebar("/es"), + // }, + // "/ja/": { + // sidebar: getSidebar("/js"), + // }, + // "/ko/": { + // sidebar: getSidebar("/ko"), + // }, + + // "/id/": { + // sidebar: getSidebar("/id"), + // }, + // "/it/": { + // sidebar: getSidebar("/it"), + // }, + // "/th/": { + // sidebar: getSidebar("/th"), + // }, }, - // themeColor: true, + darkmode: "enable", logo: "/assets/img/logo.png", - plugins: { - mdEnhance: { - // this is the default option, so you can use it directly - container: true, - codetabs: true, - checkLinks: { - // only check links in dev mode - status: "dev", - }, - }, - pwa: { - manifest: { - short_name: "SubQL Docs", - }, - favicon: "/assets/favicons/favicon.ico", - }, - }, + navbar: [ { text: "Explorer", @@ -292,598 +195,97 @@ export default defineUserConfig({ rel: "", }, ], + repo: "https://github.com/subquery/documentation", repoLabel: "Docs GitHub", docsRepo: "https://github.com/subquery/documentation", docsDir: "docs", docsBranch: "master", - }), -}); -chainWebpack: (config) => { - /** Webpack rule to handle some non-image assets that we'll use */ - config.module - .rule("files") - .test(/\.(pdf|zip|ait|log|txt)$/) - .use("file-loader") - .loader("file-loader") - .options({ - name: `[path][name].[ext]`, - limit: 10000, - esModule: false, - }); - /** Explicitly setting esModule:false - * to avoid this issue https://github.com/vuejs/vue-loader/issues/1612 - */ - config.module.rule("images").use("url-loader").options({ - limit: 10000, - esModule: false, - }); -}; + lastUpdated: true, -function getSidebar(locale: string): SidebarOptions { - return [ - { - text: "Welcome", - link: `${locale === "" ? "/" : locale}`, - }, - { - text: "Quick Start", - link: `${locale}/quickstart/quickstart`, - collapsible: true, - children: [ - `${locale}/quickstart/quickstart.md`, - { - text: "2. Specific Chains", - collapsible: true, - children: [ - { - text: "Algorand", - link: `${locale}/quickstart/quickstart_chains/algorand.md`, - }, - { - text: "Arbitrum", - link: `${locale}/quickstart/quickstart_chains/arbitrum.md`, - }, - { - text: "Astar zKatana", - link: `${locale}/quickstart/quickstart_chains/astar-zkatana.md`, - }, - { - text: "Avalanche", - collapsible: true, - children: [ - { - text: "Avalanche (Pangolin Rewards)", - link: `${locale}/quickstart/quickstart_chains/avalanche.md`, - }, - { - text: "Avalanche (Crabada NFTs)", - link: `${locale}/quickstart/quickstart_chains/avalanche-crabada.md`, - }, - ], - }, - { - text: "Base", - collapsible: true, - children: [ - { - text: "Base (Mainnet)", - link: `${locale}/quickstart/quickstart_chains/base.md`, - }, - { - text: "Base (Goerli Testnet)", - link: `${locale}/quickstart/quickstart_chains/base-goerli.md`, - }, - ], - }, - { - text: "Boba", - collapsible: true, - children: [ - { - text: "Boba (ETH)", - link: `${locale}/quickstart/quickstart_chains/boba-eth.md`, - }, - { - text: "Boba (BNB)", - link: `${locale}/quickstart/quickstart_chains/boba-bnb.md`, - }, - ], - }, - { - text: "BNB Smart Chain (BSC)", - children: [ - { - link: `${locale}/quickstart/quickstart_chains/bsc.md`, - text: "Mobox Pools", - }, - { - link: `${locale}/quickstart/quickstart_chains/bsc-pancakeswap-v3.md`, - text: "PancakeSwap", - }, - ], - }, - { - text: "Celo", - link: `${locale}/quickstart/quickstart_chains/celo.md`, - }, - { - text: "Concordium", - link: `${locale}/quickstart/quickstart_chains/concordium.md`, - }, - { - text: "Cosmos", - collapsible: true, - children: [ - { - text: "Agoric", - link: `${locale}/quickstart/quickstart_chains/cosmos-agoric.md`, - }, - { - text: "Akash", - link: `${locale}/quickstart/quickstart_chains/cosmos-akash.md`, - }, - { - text: "Archway", - link: `${locale}/quickstart/quickstart_chains/cosmos-archway.md`, - }, - { - text: "Cronos (EVM)", - link: `${locale}/quickstart/quickstart_chains/cosmos-cronos.md`, - }, - { - text: "Juno", - link: `${locale}/quickstart/quickstart_chains/cosmos-juno.md`, - }, - { - text: "Neutron", - link: `${locale}/quickstart/quickstart_chains/cosmos-neutron.md`, - }, - { - text: "Osmosis", - link: `${locale}/quickstart/quickstart_chains/cosmos-osmosis.md`, - }, - { - text: "Sei", - link: `${locale}/quickstart/quickstart_chains/cosmos-sei.md`, - }, - { - text: "Thorchain", - link: `${locale}/quickstart/quickstart_chains/cosmos-thorchain.md`, - }, - { - text: "And more Cosmos zones", - link: `${locale}/quickstart/quickstart_chains/cosmos-other.md`, - }, - ], - }, - { - text: "Ethereum", - collapsible: true, - children: [ - { - text: "Ethereum Gravatar (Simple)", - link: `${locale}/quickstart/quickstart_chains/ethereum-gravatar.md`, - }, - { - text: "Ethereum BAYC (Simple)", - link: `${locale}/quickstart/quickstart_chains/ethereum-bayc.md`, - }, - { - text: "Ethereum Chainlink (Medium)", - link: `${locale}/quickstart/quickstart_chains/ethereum-chainlink.md`, - }, - { - text: "Ethereum Opensea (Medium)", - link: `${locale}/quickstart/quickstart_chains/ethereum-opensea.md`, - }, - { - text: "Ethereum Uniswap (Complex)", - link: `${locale}/quickstart/quickstart_chains/ethereum-uniswap.md`, - }, - { - text: "Ethereum ENS (Complex)", - link: `${locale}/quickstart/quickstart_chains/ethereum-ens.md`, - }, - ], - }, - { - text: "Fantom", - link: `${locale}/quickstart/quickstart_chains/fantom.md`, - }, - { - text: "Flare", - link: `${locale}/quickstart/quickstart_chains/flare.md`, - }, - { - text: "Heco Chain", - link: `${locale}/quickstart/quickstart_chains/heco.md`, - }, - { - text: "Gnosis", - link: `${locale}/quickstart/quickstart_chains/gnosis.md`, - }, - { - text: "Harmony", - link: `${locale}/quickstart/quickstart_chains/harmony.md`, - }, - { - text: "Immutable (Testnet)", - link: `${locale}/quickstart/quickstart_chains/immutable-testnet.md`, - }, - { - text: "Klaytn", - link: `${locale}/quickstart/quickstart_chains/klaytn.md`, - }, - { - text: "Mantle", - link: `${locale}/quickstart/quickstart_chains/mantle.md`, - }, - { - text: "Meter", - link: `${locale}/quickstart/quickstart_chains/meter.md`, - }, - { - text: "Metis", - link: `${locale}/quickstart/quickstart_chains/metis.md`, - }, - { - text: "NEAR", - collapsible: true, - children: [ - { - text: "NEAR", - link: `${locale}/quickstart/quickstart_chains/near.md`, - }, - { - text: "Aurora (EVM)", - link: `${locale}/quickstart/quickstart_chains/near-aurora.md`, - }, - ], - }, - { - text: "Optimism", - link: `${locale}/quickstart/quickstart_chains/optimism.md`, - }, - { - text: "Polkadot/Substrate", - collapsible: true, - children: [ - { - text: "Astar (WASM)", - link: `${locale}/quickstart/quickstart_chains/polkadot-astar.md`, - }, - { - text: "Moonbeam (EVM)", - link: `${locale}/quickstart/quickstart_chains/polkadot-moonbeam.md`, - }, - { - text: "Humanode", - link: `${locale}/quickstart/quickstart_chains/polkadot-humanode.md`, - }, - { - text: "Kilt", - link: `${locale}/quickstart/quickstart_chains/polkadot-kilt.md`, - }, - { - text: "Polkadot/Substrate", - link: `${locale}/quickstart/quickstart_chains/polkadot.md`, - }, - { - text: "And more Polkadot chains", - link: `${locale}/quickstart/quickstart_chains/polkadot-other.md`, - }, - ], - }, - { - text: "Polygon", - collapsible: true, - children: [ - { - text: "Polygon Mainnet", - link: `${locale}/quickstart/quickstart_chains/polygon.md`, - }, - { - text: "Polygon Lens", - link: `${locale}/quickstart/quickstart_chains/polygon-lens.md`, - }, - { - text: "Polygon zkEVM", - link: `${locale}/quickstart/quickstart_chains/polygon-zkevm.md`, - }, - ], - }, - { - text: "Scroll", - collapsible: true, - children: [ - { - text: "Scroll Mainnet", - link: `${locale}/quickstart/quickstart_chains/scroll.md`, - }, - { - text: "Scroll Sepolia", - link: `${locale}/quickstart/quickstart_chains/scroll-sepolia.md`, - }, - ], - }, - { - text: "Skale", - link: `${locale}/quickstart/quickstart_chains/skale.md`, - }, - { - text: "Stellar & Soroban", - link: `${locale}/quickstart/quickstart_chains/stellar.md`, - }, - { - text: "ZkSync Era", - link: `${locale}/quickstart/quickstart_chains/zksync-era.md`, - }, - ], - }, - { - text: "3. Multi-Chain", - collapsible: true, - children: [ - { - text: "Galxe NFTs", - link: `${locale}/quickstart/quickstart_multichain/galxe-nft.md`, - }, - { - text: "Polygon Plasma Bridge", - link: `${locale}/quickstart/quickstart_multichain/polygon-plasma-bridge.md`, - }, - { - text: "Snapshot", - link: `${locale}/quickstart/quickstart_multichain/snapshot.md`, - }, - { - text: "Safe", - link: `${locale}/quickstart/quickstart_multichain/safe.md`, - }, - ], - }, - `${locale}/quickstart/whats-next.md`, - ], - }, - { - text: "Build", - link: `${locale}/build/introduction`, - collapsible: true, - children: [ - `${locale}/build/introduction.md`, - `${locale}/build/install.md`, - { - text: "Manifest File", - collapsible: true, - children: [ - `${locale}/build/manifest/avalanche.md`, - `${locale}/build/manifest/algorand.md`, - `${locale}/build/manifest/arbitrum.md`, - `${locale}/build/manifest/bsc.md`, - `${locale}/build/manifest/concordium.md`, - `${locale}/build/manifest/cosmos.md`, - `${locale}/build/manifest/ethereum.md`, - `${locale}/build/manifest/flare.md`, - `${locale}/build/manifest/gnosis.md`, - `${locale}/build/manifest/near.md`, - `${locale}/build/manifest/optimism.md`, - `${locale}/build/manifest/polkadot.md`, - `${locale}/build/manifest/polygon.md`, - `${locale}/build/manifest/stellar.md`, - ], - }, - `${locale}/build/graphql.md`, - { - text: "Mapping", - collapsible: true, - children: [ - `${locale}/build/mapping/avalanche.md`, - `${locale}/build/mapping/algorand.md`, - `${locale}/build/mapping/arbitrum.md`, - `${locale}/build/mapping/bsc.md`, - `${locale}/build/mapping/concordium.md`, - `${locale}/build/mapping/cosmos.md`, - `${locale}/build/mapping/ethereum.md`, - `${locale}/build/mapping/flare.md`, - `${locale}/build/mapping/gnosis.md`, - `${locale}/build/mapping/near.md`, - `${locale}/build/mapping/optimism.md`, - `${locale}/build/mapping/polkadot.md`, - `${locale}/build/mapping/polygon.md`, - `${locale}/build/mapping/stellar.md`, - `${locale}/build/mapping/cache.md`, - `${locale}/build/mapping/store.md`, - ], - }, - `${locale}/build/testing.md`, - `${locale}/build/graph-migration.md`, - `${locale}/build/project-upgrades.md`, - `${locale}/build/multi-chain.md`, - `${locale}/build/dynamicdatasources.md`, - `${locale}/build/substrate-evm.md`, - `${locale}/build/substrate-wasm.md`, - `${locale}/build/cosmos-evm.md`, - `${locale}/build/optimisation.md`, - ], - }, - { - text: "Run & Publish", - link: `${locale}/run_publish/publish`, - collapsible: true, - children: [ - `${locale}/run_publish/run.md`, - `${locale}/run_publish/publish.md`, - `${locale}/run_publish/optimisation.md`, - { - text: "Monitoring", - link: `${locale}/run_publish/monitor.md`, - }, - `${locale}/run_publish/cli.md`, - { - text: "Querying using GraphQL", - link: `${locale}/run_publish/query.md`, - }, - `${locale}/run_publish/aggregate.md`, - `${locale}/run_publish/subscription.md`, - `${locale}/run_publish/historical.md`, - `${locale}/run_publish/references.md`, - ], - }, - { - text: "SubQuery Network", - link: `${locale}/subquery_network/introduction`, - collapsible: true, - children: [ - `${locale}/subquery_network/introduction.md`, - { - text: "The SubQuery Tokens", - link: `${locale}/subquery_network/token/token.md`, - collapsible: true, - children: [ - `${locale}/subquery_network/token/token.md`, - `${locale}/subquery_network/token/tokenomics.md`, - `${locale}/subquery_network/token/swap.md`, - ], - }, - { - text: "Consumers", - link: `${locale}/subquery_network/consumers/introduction.md`, - collapsible: true, - children: [ - `${locale}/subquery_network/consumers/introduction.md`, - `${locale}/subquery_network/consumers/playground.md`, - `${locale}/subquery_network/consumers/faq.md`, - ], - }, - { - text: "Delegators", - link: `${locale}/subquery_network/delegators/introduction.md`, - collapsible: true, - children: [ - `${locale}/subquery_network/delegators/introduction.md`, - `${locale}/subquery_network/delegators/rewards.md`, - `${locale}/subquery_network/delegators/delegating.md`, - ], - }, - { - text: "Indexers", - link: `${locale}/subquery_network/indexers/introduction.md`, - collapsible: true, - children: [ - `${locale}/subquery_network/indexers/introduction.md`, - `${locale}/subquery_network/indexers/rewards.md`, - { - text: "Becoming an Indexer", - link: `${locale}/subquery_network/indexers/become-an-indexer.md`, - collapsible: true, - children: [ - `${locale}/subquery_network/indexers/become-an-indexer.md`, - `${locale}/subquery_network/indexers/install-indexer-locally.md`, - `${locale}/subquery_network/indexers/install-indexer-linux.md`, - `${locale}/subquery_network/indexers/separated-db.md`, - `${locale}/subquery_network/indexers/indexer-security-guide.md`, - `${locale}/subquery_network/indexers/index-project.md`, - `${locale}/subquery_network/indexers/dictionary-restore.md`, - `${locale}/subquery_network/indexers/troubleshooting-indexers.md`, - ], - }, - `${locale}/subquery_network/indexers/plans.md`, - `${locale}/subquery_network/indexers/faq.md`, - ], - }, - `${locale}/subquery_network/architects/introduction.md`, - `${locale}/subquery_network/foundation.md`, - { - text: "Design Philosophy", - link: `${locale}/subquery_network/design/design-philosophy.md`, - collapsible: true, - children: [ - `${locale}/subquery_network/design/design-philosophy.md`, - `${locale}/subquery_network/design/payment-methods.md`, - ], - }, - { - text: "Publish your Project", - link: `${locale}/subquery_network/publish.md`, + plugins: { + mdEnhance: { + // this is the default option, so you can use it directly + container: true, + codetabs: true, + checkLinks: { + // only check links in dev mode + status: "dev", }, + }, - `${locale}/subquery_network/community.md`, - ], - }, - { - text: "Courses", - link: `${locale}/academy/academy.md`, - collapsible: true, - children: [ - { - text: "Hero Course", - link: `${locale}/academy/herocourse/welcome`, - collapsible: true, - children: [ - `${locale}/academy/herocourse/welcome.md`, - `${locale}/academy/herocourse/module1.md`, - `${locale}/academy/herocourse/module2.md`, - `${locale}/academy/herocourse/module3.md`, - `${locale}/academy/herocourse/module4.md`, - `${locale}/academy/herocourse/module5.md`, - `${locale}/academy/herocourse/module6.md`, - ], - }, - { - text: "SubQuery Moonbeam Course", - link: `${locale}/academy/moonbeam_course/welcome`, - collapsible: true, - children: [ - `${locale}/academy/moonbeam_course/welcome.md`, - `${locale}/academy/moonbeam_course/lesson1.md`, - `${locale}/academy/moonbeam_course/lesson2.md`, - `${locale}/academy/moonbeam_course/lesson3.md`, - `${locale}/academy/moonbeam_course/lesson4.md`, - `${locale}/academy/moonbeam_course/lesson5.md`, - `${locale}/academy/moonbeam_course/lesson6.md`, - ], - }, - { - text: "Tutorials & Examples", - link: `${locale}/academy/tutorials_examples/introduction`, - collapsible: true, - children: [ - `${locale}/academy/tutorials_examples/introduction.md`, - `${locale}/academy/tutorials_examples/block-height.md`, - `${locale}/academy/tutorials_examples/batch-size.md`, - `${locale}/academy/tutorials_examples/run-indexer.md`, - `${locale}/academy/tutorials_examples/dictionary.md`, - `${locale}/academy/tutorials_examples/debug-projects.md`, - `${locale}/academy/tutorials_examples/delete-projects.md`, - `${locale}/academy/tutorials_examples/terminology.md`, - ], + pwa: { + manifest: { + short_name: "SubQL Docs", }, - `${locale}/academy/subquery101/subquery101.md`, - ], - }, - { - text: "Miscellaneous", - link: `${locale}/miscellaneous/contributing`, - collapsible: true, - children: [ - `${locale}/miscellaneous/contributing.md`, - `${locale}/miscellaneous/social_media.md`, - `${locale}/miscellaneous/branding.md`, - `${locale}/miscellaneous/ambassadors.md`, - `${locale}/miscellaneous/avalanche-eth-migration.md`, - `${locale}/miscellaneous/ipfs.md`, - `${locale}/miscellaneous/vulnerability-reporting.md`, - ], - }, - { - text: "FAQs", - link: `${locale}/faqs/faqs.md`, - }, - { - text: "Glossary", - link: `${locale}/glossary/glossary.md`, + favicon: "/assets/favicons/favicon.ico", + }, + + seo: { + autoDescription: true, + twitterID: "@SubQueryNetwork", + fallBackImage: "https://static.subquery.network/link-share.jpg", + }, }, - ]; -} + }), + + plugins: [ + docsearchPlugin({ + appId: "30B5W460WL", + apiKey: "fdae5afc6c3711a8b4f53a4801b43143", + indexName: "subquery_academy", + }), + googleAnalyticsPlugin({ + id: "G-MY90N76MNK", + }), + redirectPlugin({ + config: { + "/subquery_network/architects.html": + "/subquery_network/architects/introduction.html", + "/subquery_network/consumers.html": + "/subquery_network/consumers/introduction.html", + "/subquery_network/delegators.html": + "/subquery_network/delegators/introduction.html", + "/subquery_network/indexers.html": + "/subquery_network/indexers/introduction.html", + "/subquery_network/token.html": "/subquery_network/token/token.html", + "/subquery_network/design-philosophy.html": + "/subquery_network/design/design-philosophy.html", + "/subquery_network/payment-methods.html": + "/subquery_network/design/payment-methods.html", + "/subquery_network/kepler/welcome.html": + "/subquery_network/introduction.html", + "/subquery_network/kepler/ksqt.html": + "/subquery_network/token/token.html", + "/subquery_network/kepler/indexers/become-an-indexer.html": + "/subquery_network/indexers/become-an-indexer.html", + "/subquery_network/kepler/indexers/install-indexer-locally.html": + "/subquery_network/indexers/install-indexer-locally.html", + "/subquery_network/kepler/indexers/install-indexer-linux.html": + "/subquery_network/indexers/install-indexer-linux.html", + "/subquery_network/kepler/indexers/index-project.html": + "/subquery_network/indexers/index-project.html", + "/subquery_network/kepler/indexers/dictionary-restore.html": + "/subquery_network/indexers/dictionary-restore.html", + "/subquery_network/kepler/indexers/plans.html": + "/subquery_network/indexers/plans.html", + "/subquery_network/kepler/indexers/troubleshooting-indexers.html": + "/subquery_network/indexers/troubleshooting-indexers.html", + "/subquery_network/kepler/indexers/faqs-indexers.html": + "/subquery_network/indexers/faqs-indexers.html", + "/subquery_network/kepler/indexers/ssl-configuration.html": + "/subquery_network/indexers/indexer-security-guide.html", + "/subquery_network/indexers/ssl-configuration.html": + "/subquery_network/indexers/indexer-security-guide.html", + "/build/manifest/terra.html": "/build/manifest/cosmos.html", + "/build/mapping/terra.html": "/build/mapping/cosmos.html", + "/build/quickstart/quickstart_chains/terra.html": + "/build/quickstart/quickstart_chains/cosmos.html", + "/run_publish/ipfs.html": "/miscellaneous/ipfs.html", + }, + }), + ], + + shouldPrefetch: false, +}); diff --git a/docs/.vuepress/sidebar.ts b/docs/.vuepress/sidebar.ts new file mode 100644 index 00000000000..56ad19b0c23 --- /dev/null +++ b/docs/.vuepress/sidebar.ts @@ -0,0 +1,567 @@ +import { sidebar } from "vuepress-theme-hope"; + +export const getSidebar = (locale: string) => + sidebar([ + { + text: "Welcome", + link: `${locale === "" ? "/" : locale}`, + }, + { + text: "Quick Start", + link: `${locale}/quickstart/quickstart`, + collapsible: true, + children: [ + `${locale}/quickstart/quickstart.md`, + { + text: "2. Specific Chains", + collapsible: true, + children: [ + { + text: "Algorand", + link: `${locale}/quickstart/quickstart_chains/algorand.md`, + }, + { + text: "Arbitrum", + link: `${locale}/quickstart/quickstart_chains/arbitrum.md`, + }, + { + text: "Astar zKatana", + link: `${locale}/quickstart/quickstart_chains/astar-zkatana.md`, + }, + { + text: "Avalanche", + collapsible: true, + children: [ + { + text: "Avalanche (Pangolin Rewards)", + link: `${locale}/quickstart/quickstart_chains/avalanche.md`, + }, + { + text: "Avalanche (Crabada NFTs)", + link: `${locale}/quickstart/quickstart_chains/avalanche-crabada.md`, + }, + ], + }, + { + text: "Base", + collapsible: true, + children: [ + { + text: "Base (Mainnet)", + link: `${locale}/quickstart/quickstart_chains/base.md`, + }, + { + text: "Base (Goerli Testnet)", + link: `${locale}/quickstart/quickstart_chains/base-goerli.md`, + }, + ], + }, + { + text: "Boba", + collapsible: true, + children: [ + { + text: "Boba (ETH)", + link: `${locale}/quickstart/quickstart_chains/boba-eth.md`, + }, + { + text: "Boba (BNB)", + link: `${locale}/quickstart/quickstart_chains/boba-bnb.md`, + }, + ], + }, + { + text: "BNB Smart Chain (BSC)", + children: [ + { + link: `${locale}/quickstart/quickstart_chains/bsc.md`, + text: "Mobox Pools", + }, + { + link: `${locale}/quickstart/quickstart_chains/bsc-pancakeswap-v3.md`, + text: "PancakeSwap", + }, + ], + }, + { + text: "Celo", + link: `${locale}/quickstart/quickstart_chains/celo.md`, + }, + { + text: "Concordium", + link: `${locale}/quickstart/quickstart_chains/concordium.md`, + }, + { + text: "Cosmos", + collapsible: true, + children: [ + { + text: "Agoric", + link: `${locale}/quickstart/quickstart_chains/cosmos-agoric.md`, + }, + { + text: "Akash", + link: `${locale}/quickstart/quickstart_chains/cosmos-akash.md`, + }, + { + text: "Archway", + link: `${locale}/quickstart/quickstart_chains/cosmos-archway.md`, + }, + { + text: "Cronos (EVM)", + link: `${locale}/quickstart/quickstart_chains/cosmos-cronos.md`, + }, + { + text: "Juno", + link: `${locale}/quickstart/quickstart_chains/cosmos-juno.md`, + }, + { + text: "Neutron", + link: `${locale}/quickstart/quickstart_chains/cosmos-neutron.md`, + }, + { + text: "Osmosis", + link: `${locale}/quickstart/quickstart_chains/cosmos-osmosis.md`, + }, + { + text: "Sei", + link: `${locale}/quickstart/quickstart_chains/cosmos-sei.md`, + }, + { + text: "Thorchain", + link: `${locale}/quickstart/quickstart_chains/cosmos-thorchain.md`, + }, + { + text: "And more Cosmos zones", + link: `${locale}/quickstart/quickstart_chains/cosmos-other.md`, + }, + ], + }, + { + text: "Ethereum", + collapsible: true, + children: [ + { + text: "Ethereum Gravatar (Simple)", + link: `${locale}/quickstart/quickstart_chains/ethereum-gravatar.md`, + }, + { + text: "Ethereum BAYC (Simple)", + link: `${locale}/quickstart/quickstart_chains/ethereum-bayc.md`, + }, + { + text: "Ethereum Chainlink (Medium)", + link: `${locale}/quickstart/quickstart_chains/ethereum-chainlink.md`, + }, + { + text: "Ethereum Opensea (Medium)", + link: `${locale}/quickstart/quickstart_chains/ethereum-opensea.md`, + }, + { + text: "Ethereum Uniswap (Complex)", + link: `${locale}/quickstart/quickstart_chains/ethereum-uniswap.md`, + }, + { + text: "Ethereum ENS (Complex)", + link: `${locale}/quickstart/quickstart_chains/ethereum-ens.md`, + }, + ], + }, + { + text: "Fantom", + link: `${locale}/quickstart/quickstart_chains/fantom.md`, + }, + { + text: "Flare", + link: `${locale}/quickstart/quickstart_chains/flare.md`, + }, + { + text: "Heco Chain", + link: `${locale}/quickstart/quickstart_chains/heco.md`, + }, + { + text: "Gnosis", + link: `${locale}/quickstart/quickstart_chains/gnosis.md`, + }, + { + text: "Harmony", + link: `${locale}/quickstart/quickstart_chains/harmony.md`, + }, + { + text: "Immutable (Testnet)", + link: `${locale}/quickstart/quickstart_chains/immutable-testnet.md`, + }, + { + text: "Klaytn", + link: `${locale}/quickstart/quickstart_chains/klaytn.md`, + }, + { + text: "Mantle", + link: `${locale}/quickstart/quickstart_chains/mantle.md`, + }, + { + text: "Meter", + link: `${locale}/quickstart/quickstart_chains/meter.md`, + }, + { + text: "Metis", + link: `${locale}/quickstart/quickstart_chains/metis.md`, + }, + { + text: "NEAR", + collapsible: true, + children: [ + { + text: "NEAR", + link: `${locale}/quickstart/quickstart_chains/near.md`, + }, + { + text: "Aurora (EVM)", + link: `${locale}/quickstart/quickstart_chains/near-aurora.md`, + }, + ], + }, + { + text: "Optimism", + link: `${locale}/quickstart/quickstart_chains/optimism.md`, + }, + { + text: "Polkadot/Substrate", + collapsible: true, + children: [ + { + text: "Astar (WASM)", + link: `${locale}/quickstart/quickstart_chains/polkadot-astar.md`, + }, + { + text: "Moonbeam (EVM)", + link: `${locale}/quickstart/quickstart_chains/polkadot-moonbeam.md`, + }, + { + text: "Humanode", + link: `${locale}/quickstart/quickstart_chains/polkadot-humanode.md`, + }, + { + text: "Kilt", + link: `${locale}/quickstart/quickstart_chains/polkadot-kilt.md`, + }, + { + text: "Polkadot/Substrate", + link: `${locale}/quickstart/quickstart_chains/polkadot.md`, + }, + { + text: "And more Polkadot chains", + link: `${locale}/quickstart/quickstart_chains/polkadot-other.md`, + }, + ], + }, + { + text: "Polygon", + collapsible: true, + children: [ + { + text: "Polygon Mainnet", + link: `${locale}/quickstart/quickstart_chains/polygon.md`, + }, + { + text: "Polygon Lens", + link: `${locale}/quickstart/quickstart_chains/polygon-lens.md`, + }, + { + text: "Polygon zkEVM", + link: `${locale}/quickstart/quickstart_chains/polygon-zkevm.md`, + }, + ], + }, + { + text: "Scroll", + collapsible: true, + children: [ + { + text: "Scroll Mainnet", + link: `${locale}/quickstart/quickstart_chains/scroll.md`, + }, + { + text: "Scroll Sepolia", + link: `${locale}/quickstart/quickstart_chains/scroll-sepolia.md`, + }, + ], + }, + { + text: "Skale", + link: `${locale}/quickstart/quickstart_chains/skale.md`, + }, + { + text: "Stellar & Soroban", + link: `${locale}/quickstart/quickstart_chains/stellar.md`, + }, + { + text: "ZkSync Era", + link: `${locale}/quickstart/quickstart_chains/zksync-era.md`, + }, + ], + }, + { + text: "3. Multi-Chain", + collapsible: true, + children: [ + { + text: "Galxe NFTs", + link: `${locale}/quickstart/quickstart_multichain/galxe-nft.md`, + }, + { + text: "Polygon Plasma Bridge", + link: `${locale}/quickstart/quickstart_multichain/polygon-plasma-bridge.md`, + }, + { + text: "Snapshot", + link: `${locale}/quickstart/quickstart_multichain/snapshot.md`, + }, + { + text: "Safe", + link: `${locale}/quickstart/quickstart_multichain/safe.md`, + }, + ], + }, + `${locale}/quickstart/whats-next.md`, + ], + }, + { + text: "Build", + link: `${locale}/build/introduction`, + collapsible: true, + children: [ + `${locale}/build/introduction.md`, + `${locale}/build/install.md`, + { + text: "Manifest File", + collapsible: true, + children: [ + `${locale}/build/manifest/avalanche.md`, + `${locale}/build/manifest/algorand.md`, + `${locale}/build/manifest/arbitrum.md`, + `${locale}/build/manifest/bsc.md`, + `${locale}/build/manifest/concordium.md`, + `${locale}/build/manifest/cosmos.md`, + `${locale}/build/manifest/ethereum.md`, + `${locale}/build/manifest/flare.md`, + `${locale}/build/manifest/gnosis.md`, + `${locale}/build/manifest/near.md`, + `${locale}/build/manifest/optimism.md`, + `${locale}/build/manifest/polkadot.md`, + `${locale}/build/manifest/polygon.md`, + `${locale}/build/manifest/stellar.md`, + ], + }, + `${locale}/build/graphql.md`, + { + text: "Mapping", + collapsible: true, + children: [ + `${locale}/build/mapping/avalanche.md`, + `${locale}/build/mapping/algorand.md`, + `${locale}/build/mapping/arbitrum.md`, + `${locale}/build/mapping/bsc.md`, + `${locale}/build/mapping/concordium.md`, + `${locale}/build/mapping/cosmos.md`, + `${locale}/build/mapping/ethereum.md`, + `${locale}/build/mapping/flare.md`, + `${locale}/build/mapping/gnosis.md`, + `${locale}/build/mapping/near.md`, + `${locale}/build/mapping/optimism.md`, + `${locale}/build/mapping/polkadot.md`, + `${locale}/build/mapping/polygon.md`, + `${locale}/build/mapping/stellar.md`, + `${locale}/build/mapping/cache.md`, + `${locale}/build/mapping/store.md`, + ], + }, + `${locale}/build/testing.md`, + `${locale}/build/graph-migration.md`, + `${locale}/build/project-upgrades.md`, + `${locale}/build/multi-chain.md`, + `${locale}/build/dynamicdatasources.md`, + `${locale}/build/substrate-evm.md`, + `${locale}/build/substrate-wasm.md`, + `${locale}/build/cosmos-evm.md`, + `${locale}/build/optimisation.md`, + ], + }, + { + text: "Run & Publish", + link: `${locale}/run_publish/publish`, + collapsible: true, + children: [ + `${locale}/run_publish/run.md`, + `${locale}/run_publish/publish.md`, + `${locale}/run_publish/optimisation.md`, + { + text: "Monitoring", + link: `${locale}/run_publish/monitor.md`, + }, + `${locale}/run_publish/cli.md`, + { + text: "Querying using GraphQL", + link: `${locale}/run_publish/query.md`, + }, + `${locale}/run_publish/aggregate.md`, + `${locale}/run_publish/subscription.md`, + `${locale}/run_publish/historical.md`, + `${locale}/run_publish/references.md`, + ], + }, + { + text: "SubQuery Network", + link: `${locale}/subquery_network/introduction`, + collapsible: true, + children: [ + `${locale}/subquery_network/introduction.md`, + { + text: "The SubQuery Tokens", + link: `${locale}/subquery_network/token/token.md`, + collapsible: true, + children: [ + `${locale}/subquery_network/token/token.md`, + `${locale}/subquery_network/token/tokenomics.md`, + `${locale}/subquery_network/token/swap.md`, + ], + }, + { + text: "Consumers", + link: `${locale}/subquery_network/consumers/introduction.md`, + collapsible: true, + children: [ + `${locale}/subquery_network/consumers/introduction.md`, + `${locale}/subquery_network/consumers/playground.md`, + `${locale}/subquery_network/consumers/faq.md`, + ], + }, + { + text: "Delegators", + link: `${locale}/subquery_network/delegators/introduction.md`, + collapsible: true, + children: [ + `${locale}/subquery_network/delegators/introduction.md`, + `${locale}/subquery_network/delegators/rewards.md`, + `${locale}/subquery_network/delegators/delegating.md`, + ], + }, + { + text: "Indexers", + link: `${locale}/subquery_network/indexers/introduction.md`, + collapsible: true, + children: [ + `${locale}/subquery_network/indexers/introduction.md`, + `${locale}/subquery_network/indexers/rewards.md`, + { + text: "Becoming an Indexer", + link: `${locale}/subquery_network/indexers/become-an-indexer.md`, + collapsible: true, + children: [ + `${locale}/subquery_network/indexers/become-an-indexer.md`, + `${locale}/subquery_network/indexers/install-indexer-locally.md`, + `${locale}/subquery_network/indexers/install-indexer-linux.md`, + `${locale}/subquery_network/indexers/separated-db.md`, + `${locale}/subquery_network/indexers/indexer-security-guide.md`, + `${locale}/subquery_network/indexers/index-project.md`, + `${locale}/subquery_network/indexers/dictionary-restore.md`, + `${locale}/subquery_network/indexers/troubleshooting-indexers.md`, + ], + }, + `${locale}/subquery_network/indexers/plans.md`, + `${locale}/subquery_network/indexers/faq.md`, + ], + }, + `${locale}/subquery_network/architects/introduction.md`, + `${locale}/subquery_network/foundation.md`, + { + text: "Design Philosophy", + link: `${locale}/subquery_network/design/design-philosophy.md`, + collapsible: true, + children: [ + `${locale}/subquery_network/design/design-philosophy.md`, + `${locale}/subquery_network/design/payment-methods.md`, + ], + }, + { + text: "Publish your Project", + link: `${locale}/subquery_network/publish.md`, + }, + + `${locale}/subquery_network/community.md`, + ], + }, + { + text: "Courses", + link: `${locale}/academy/academy.md`, + collapsible: true, + children: [ + { + text: "Hero Course", + link: `${locale}/academy/herocourse/welcome`, + collapsible: true, + children: [ + `${locale}/academy/herocourse/welcome.md`, + `${locale}/academy/herocourse/module1.md`, + `${locale}/academy/herocourse/module2.md`, + `${locale}/academy/herocourse/module3.md`, + `${locale}/academy/herocourse/module4.md`, + `${locale}/academy/herocourse/module5.md`, + `${locale}/academy/herocourse/module6.md`, + ], + }, + { + text: "SubQuery Moonbeam Course", + link: `${locale}/academy/moonbeam_course/welcome`, + collapsible: true, + children: [ + `${locale}/academy/moonbeam_course/welcome.md`, + `${locale}/academy/moonbeam_course/lesson1.md`, + `${locale}/academy/moonbeam_course/lesson2.md`, + `${locale}/academy/moonbeam_course/lesson3.md`, + `${locale}/academy/moonbeam_course/lesson4.md`, + `${locale}/academy/moonbeam_course/lesson5.md`, + `${locale}/academy/moonbeam_course/lesson6.md`, + ], + }, + { + text: "Tutorials & Examples", + link: `${locale}/academy/tutorials_examples/introduction`, + collapsible: true, + children: [ + `${locale}/academy/tutorials_examples/introduction.md`, + `${locale}/academy/tutorials_examples/block-height.md`, + `${locale}/academy/tutorials_examples/batch-size.md`, + `${locale}/academy/tutorials_examples/run-indexer.md`, + `${locale}/academy/tutorials_examples/dictionary.md`, + `${locale}/academy/tutorials_examples/debug-projects.md`, + `${locale}/academy/tutorials_examples/delete-projects.md`, + `${locale}/academy/tutorials_examples/terminology.md`, + ], + }, + `${locale}/academy/subquery101/subquery101.md`, + ], + }, + { + text: "Miscellaneous", + link: `${locale}/miscellaneous/contributing`, + collapsible: true, + children: [ + `${locale}/miscellaneous/contributing.md`, + `${locale}/miscellaneous/social_media.md`, + `${locale}/miscellaneous/branding.md`, + `${locale}/miscellaneous/ambassadors.md`, + `${locale}/miscellaneous/avalanche-eth-migration.md`, + `${locale}/miscellaneous/ipfs.md`, + `${locale}/miscellaneous/vulnerability-reporting.md`, + ], + }, + { + text: "FAQs", + link: `${locale}/faqs/faqs.md`, + }, + { + text: "Glossary", + link: `${locale}/glossary/glossary.md`, + }, + ]); diff --git a/docs/.vuepress/styles/config.scss b/docs/.vuepress/styles/config.scss deleted file mode 100644 index f91061d7ba2..00000000000 --- a/docs/.vuepress/styles/config.scss +++ /dev/null @@ -1,3 +0,0 @@ -// you can change config here -$colors: #c0392b, #d35400, #f39c12, #27ae60, #16a085, #2980b9, #8e44ad, #2c3e50, - #7f8c8d !default; diff --git a/docs/.vuepress/styles/index.scss b/docs/.vuepress/styles/index.scss index e3f374ce1e6..766fc240981 100644 --- a/docs/.vuepress/styles/index.scss +++ b/docs/.vuepress/styles/index.scss @@ -54,15 +54,18 @@ iframe { font-weight: 500; font-family: var(--font-family); } + .external-link-icon { display: none; } .nav-item { margin: 0; + .nav-link { padding: 16px; transition: color 0.3s; + &.active { &::after { display: none; @@ -120,7 +123,6 @@ iframe { } html[data-theme="dark"] { - --bg-color: #060f32 !important; --dark-grey: #fff; --primary-color: var(--theme-color); --secondary-color: #ff4581; diff --git a/docs/.vuepress/styles/palette.scss b/docs/.vuepress/styles/palette.scss index d6c41e7b2fa..5ecaf40945a 100644 --- a/docs/.vuepress/styles/palette.scss +++ b/docs/.vuepress/styles/palette.scss @@ -1,18 +1,13 @@ -// you can change colors here -@font-face { - font-family: Inter; - src: url("/assets/fonts/Inter-Regular.ttf"); -} - $theme-color: #4388dd; -$font-family: 'Inter, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif'; +$primary-color: $theme-color; + +$bg-color: #060f32; +$text-color: #fff; +$border-color: #34414b; + $navbar-height: 80px; $navbar-horizontal-padding: 24px; $navbar-vertical-padding: 16px; -$bg-color: ( - light: #060f32, - dark: #060f32, -); + +$font-family: 'Inter, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif'; $font-family-heading: "Futura"; -$text-color: #fff; -$border-color: #34414b; diff --git a/docs/README.md b/docs/README.md index 74bab363157..5846371cd96 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,6 +3,7 @@ footer: false lastUpdated: false contributors: false editLink: false +photoSwipe: false --- @@ -218,7 +219,7 @@ editLink: false
SubQuery © 2023
- +