feat: adds preview titles (#669)

* feat: adds OG plugin * fix: removes hardcoded values * feat: description in devtools * fix: removes frontmatter data * feat: adds layer zero * fix: twitter title and desc * fix: test twitter fix * fix: twitter card, again * fix: twitter desc, again * fix: some titles * feat: all dev and architecture pages * fix: all tools pages * fix: api and sdk pages * fix: adds plugin again * fix: bad title tag * fix: title * fix: capitalize Docs in title * fix: capitalization titles
matter-labs · Aug 22, 2023 · 952a2ca · 952a2ca
1 parent 00f3738
commit 952a2ca
Show file tree

Hide file tree

Showing 119 changed files with 914 additions and 7 deletions.
diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts
@@ -4,6 +4,7 @@ import vue from "@vitejs/plugin-vue";
 import theme from "./theme.js";
 import { pwaPlugin } from "vuepress-plugin-pwa2";
 import { getDirname, path } from "@vuepress/utils";
+import { seoPlugin } from "vuepress-plugin-seo2";
 
 import { registerComponentsPlugin } from "@vuepress/plugin-register-components";
 
@@ -16,7 +17,7 @@ export default defineUserConfig({
   dest: "dist/docs",
 
   base: "/docs/",
-  title: "Welcome to our Docs | zkSync Era",
+  title: "Welcome to our Docs | zkSync Era Docs",
 
   head: [
     ["link", { rel: "canonical", href: "https://era.zksync.io/docs/" }],
@@ -50,7 +51,6 @@ export default defineUserConfig({
         content: "zkSync Era is a user-centric zk rollup platform from Matter Labs. It is a scaling solution for Ethereum, already live on Ethereum mainnet.",
       },
     ],
-
     ["meta", { name: "twitter:card", content: "summary" }],
     ["meta", { name: "twitter:title", content: "Welcome to our Docs | zkSync Era" }],
     [
@@ -99,7 +99,6 @@ export default defineUserConfig({
         let contributorsDiv = document.querySelector('.contributors');
         contributorsDiv.innerHTML = '<span class="label">Contributors: </span>' + updatedList;
       
-        console.log('Top 5 contributors:', updatedList);
       });
 
       `,
@@ -109,6 +108,7 @@ export default defineUserConfig({
   theme,
 
   plugins: [
+    seoPlugin,
     pwaPlugin({
       update: "force",
     }),

diff --git a/docs/.vuepress/public/images/tools/layerzero-logo.png b/docs/.vuepress/public/images/tools/layerzero-logo.png
diff --git a/docs/api/README.md b/docs/api/README.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Web3 API & SDKs | zkSync Era Docs
+---
+
 # Contents
 
 ## JSON-RPC API

diff --git a/docs/api/api.md b/docs/api/api.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Web3 JSON-RPC API | zkSync Era Docs
+---
+
 # Web3 JSON-RPC API
 
 zkSync Era supports the standard [Ethereum JSON-RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc/) and adds some L2-specific features.

diff --git a/docs/api/go/README.md b/docs/api/go/README.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK | zkSync Era Docs
+---
+
 # Go SDK
 
 While most of the existing SDKs should work out of the box, deploying smart contracts or using unique zkSync features, such as paying fees in other tokens, requires providing additional fields to those that Ethereum transactions have by default.

diff --git a/docs/api/go/accounts-l1-l2.md b/docs/api/go/accounts-l1-l2.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK L1/L2 Transactions | zkSync Era Docs
+---
+
 # Accounts: L1<->L2 transactions
 
 This section explores the methods which allow the [account](./accounts.md) to send transactions among both L1 to L2 networks.

diff --git a/docs/api/go/accounts.md b/docs/api/go/accounts.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Accounts | zkSync Era Docs
+---
+
 # Accounts: Overview
 
 The `accounts` package provides abstractions that wrap operations that interact with an account. An account typically contains a private

diff --git a/docs/api/go/clients.md b/docs/api/go/clients.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Clients | zkSync Era Docs
+---
+
 # Clients
 
 :::info Note

diff --git a/docs/api/go/contracts.md b/docs/api/go/contracts.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Contracts | zkSync Era Docs
+---
+
 # Contracts
 
 The usual way to deploy a contract with the `geth` library is to use `abigen` with the provided `--bin` option, which generates a function

diff --git a/docs/api/go/examples/create.md b/docs/api/go/examples/create.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Create Example | zkSync Era Docs
+---
+
 # Deploy contract with CREATE opcode
 
 With zkSync Era contract can be deployed using the CREATE by simply building the contract into a binary format and deploying it to the

diff --git a/docs/api/go/examples/create2.md b/docs/api/go/examples/create2.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Create2 Example | zkSync Era Docs
+---
+
 # Deploy contract with CREATE2 opcode
 
 With zkSync Era contract can be deployed using the CREATE2 by simply building the contract into a binary format and deploying it to the

diff --git a/docs/api/go/examples/custom-paymaster/deploy-account.md b/docs/api/go/examples/custom-paymaster/deploy-account.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Deploy Paymaster Example | zkSync Era Docs
+---
+
 # Deploy paymaster
 
 Deploy the paymaster account, which will receive the token deployed in the [previous](deploy-token.md) step and pay the fee in ETH for the account that

diff --git a/docs/api/go/examples/custom-paymaster/deploy-token.md b/docs/api/go/examples/custom-paymaster/deploy-token.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Deploy Token Example | zkSync Era Docs
+---
+
 # Deploy token
 
 Deploy the token which will be used to pay transaction fee.

diff --git a/docs/api/go/examples/custom-paymaster/use-paymaster.md b/docs/api/go/examples/custom-paymaster/use-paymaster.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Use Paymaster Example | zkSync Era Docs
+---
+
 # Use paymaster
 
 This example demonstrates how to use a paymaster to facilitate fee payment with an ERC20 token.

diff --git a/docs/api/go/examples/deposit.md b/docs/api/go/examples/deposit.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Deposit Example | zkSync Era Docs
+---
+
 # Deposit
 
 ## Deposit ETH

diff --git a/docs/api/go/examples/get-confirmed-tokens.md b/docs/api/go/examples/get-confirmed-tokens.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Get Tokens Example | zkSync Era Docs
+---
+
 # Get all confirmed tokens on zkSync Era
 
 Following example shows how to get all confirmed tokens on zkSync Era.

diff --git a/docs/api/go/examples/transfer.md b/docs/api/go/examples/transfer.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Transfer Example | zkSync Era Docs
+---
+
 # Transfer
 
 ## Transfer ETH

diff --git a/docs/api/go/examples/withdraw.md b/docs/api/go/examples/withdraw.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Withdraw Example | zkSync Era Docs
+---
+
 # Withdrawal
 
 When it comes to withdrawals there are several notes that needs to be taken into account:

diff --git a/docs/api/go/features.md b/docs/api/go/features.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Features | zkSync Era Docs
+---
+
 # zkSync Era features
 
 While zkSync Era is mostly Web3-compatible, it has some differences compared to Ethereum. The major of those are:

diff --git a/docs/api/go/getting-started.md b/docs/api/go/getting-started.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Getting Started | zkSync Era Docs
+---
+
 # Getting started
 
 This is a short introduction to `zksync2-go` SDK, but covers many of the most common operations that developers require and provides a

diff --git a/docs/api/go/paymaster-utils.md b/docs/api/go/paymaster-utils.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Paymaster Utilities | zkSync Era Docs
+---
+
 # Paymaster utilities
 
 The [paymaster utilities library](https://github.com/zksync-sdk/zksync2-go/blob/main/utils/paymaster.go) contains essential utilities for using paymasters on zkSync Era.

diff --git a/docs/api/go/types/accounts.md b/docs/api/go/types/accounts.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Accounts Package | zkSync Era Docs
+---
+
 # `accounts` package
 
 ### `CallOpts`

diff --git a/docs/api/go/types/clients.md b/docs/api/go/types/clients.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Clients Package | zkSync Era Docs
+---
+
 # `clients` package
 
 ### `BlockRange`

diff --git a/docs/api/go/types/eip712.md b/docs/api/go/types/eip712.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK EIP712 Package | zkSync Era Docs
+---
+
 # `eip712` package
 
 ### `Domain`

diff --git a/docs/api/go/types/intro.md b/docs/api/go/types/intro.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Types | zkSync Era Docs
+---
+
 # Types
 
 Types are placed in three packages for different purposes:

diff --git a/docs/api/go/types/types.md b/docs/api/go/types/types.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Types Package | zkSync Era Docs
+---
+
 # `types` package
 
 ### `AccountAbstractionVersion`

diff --git a/docs/api/go/utils.md b/docs/api/go/utils.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Go SDK Utils | zkSync Era Docs
+---
+
 # Utils
 
 Provides essential utilities for building on zkSync Era.

diff --git a/docs/api/java/README.md b/docs/api/java/README.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Java SDK | zkSync Era Docs
+---
+
 # Java SDK
 
 While most of the existing SDKs should work out of the box, deploying smart contracts or using unique zkSync Era features, such as paying fees in other tokens, requires providing additional fields to those that Ethereum transactions have by default.

diff --git a/docs/api/java/accounts-l1-l2.md b/docs/api/java/accounts-l1-l2.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Java SDK L1/L2 Transactions | zkSync Era Docs
+---
+
 # Accounts: L1->L2 transactions
 
 This section explores the methods which allow the [account](./accounts.md) classes to send transactions from L1 to L2.

diff --git a/docs/api/java/accounts.md b/docs/api/java/accounts.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Java SDK Accounts | zkSync Era Docs
+---
+
 # Accounts
 
 ## PrivateKeyEthSigner

diff --git a/docs/api/java/getting-started.md b/docs/api/java/getting-started.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Java SDK Getting Started | zkSync Era Docs
+---
+
 # Getting started
 
 In this guide we will demonstrate how to:

diff --git a/docs/api/java/providers.md b/docs/api/java/providers.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: Java SDK Providers | zkSync Era Docs
+---
+
 # Providers
 
 Providers are objects that wrap interactions with the zkSync Era node. If you are new to the concept of providers in `web3`, check out the [Web3j docs](https://docs.web3j.io/4.9.8/getting_started/interacting_with_node/).

diff --git a/docs/api/js/README.md b/docs/api/js/README.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: JS SDK | zkSync Era Docs
+---
+
 # JavaScript Web3 SDK
 
 While most of the existing SDKs should work out of the box, deploying smart contracts or using unique zkSync features, like paying fees in other tokens, requires providing additional fields to those that Ethereum transactions have by default.

diff --git a/docs/api/js/accounts-l1-l2.md b/docs/api/js/accounts-l1-l2.md
@@ -1,3 +1,10 @@
+---
+head:
+  - - meta
+    - name: "twitter:title"
+      content: JS SDK L1/L2 Transactions | zkSync Era Docs
+---
+
 # Accounts: L1->L2 transactions
 
 This section explores the methods which allow the [account](./accounts.md) classes to send transactions from L1 to L2.