feat: add Vitepress site in place of Docusaurus site (celestiaorg#1169)

From https://github.com/celestiaorg/docs-vitepress/tree/jcs/update-base-url

Author: jcstein

.env

@@ -1,15 +1,19 @@
 {
-  "extends": ["plugin:mdx/recommended"],
-  "settings": {
-    "mdx/code-blocks": true,
-    "mdx/language-mapper": {}
+  "env": {
+    "browser": true,
+    "es2021": true,
+    "node": true
   },
-  "overrides": [
-    {
-      "files": ["*.mdx"],
-      "rules": {
-        "no-unused-expressions": "off"
-      }
-    }
-  ]
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:vue/vue3-essential"
+  ],
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "parser": "@typescript-eslint/parser",
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint", "vue"],
+  "rules": {}
 }

.eslintrc.json

@@ -1,44 +1,57 @@
-name: Deploy to GitHub Pages
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy VitePress site to Pages
 
 on:
+  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
+  # using the `master` branch as the default branch.
   push:
-    branches:
-      - main
+    branches: [main]
+
+  # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions: write-all
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
 jobs:
-  deploy:
-    name: Deploy to GitHub Pages
+  # Build job
+  build:
     runs-on: ubuntu-latest
-    env:
-      CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
-    permissions: write-all
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - name: Checkout
+        uses: actions/checkout@v3
         with:
-          node-version: 16.x
-          cache: npm
-
-      - run: yarn install --frozen-lockfile
-      - run: yarn crowdin:sync
-      - name: Clean Crowdin Front Matter issues
-        run: bash clean.sh
-        shell: bash
-      - run: yarn build
-
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      # - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: yarn # or pnpm / npm
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Install dependencies
+        run: yarn install # or pnpm install / npm ci
+      - name: Build with VitePress
+        run: yarn build # or pnpm docs:build / npm docs:build
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./build
-          keep_files: ${{ github.event_name == 'push' }}
-          force_orphan: true
+          publish_dir: ./.vitepress/dist
+          keep_files: ${{ github.event_name != 'workflow_dispatch' }}
           # The following lines assign commit authorship to the official
           # GH-Actions bot for deploys to `gh-pages` branch:
           # https://github.com/actions/checkout/issues/13#issuecomment-724415212
           # The GH actions bot is used by default if you didn't specify the two fields.
           # You can swap them out with your own user credentials.
           cname: docs.celestia.org
-          user_name: YazzyYaz
-          user_email: yaz@celestia.org
+          user_name: jcstein
+          user_email: joshcs@celestia.org

.github/workflows/deploy.yml

@@ -105,18 +105,18 @@ jobs:
           export default ${{ inputs.network }}Versions;
           EOF
           )
-          echo $CONTENTS > docs/constants/\${{ inputs.network }}_versions.js
+          echo $CONTENTS > .vitepress/constants/\${{ inputs.network }}_versions.js
       - name: Install Prettier
         run: |
           npm install -g prettier
       - name: Format the code with Prettier
         run: |
-          prettier docs/constants/\${{ inputs.network }}_versions.js --write
+          prettier .vitepress/constants/\${{ inputs.network }}_versions.js --write
       - name: Open PR
         uses: peter-evans/create-pull-request@v4
         with:
           # This github action has a lot of options, currently we just tweak the
           # commit-message and title of the PR.
           commit-message: "[automated GH action] update latest release tags & commit sha (${{ inputs.network }})"
           title: "[GH Action] Update release tags and commit SHAs for ${{ inputs.network }}"
-          token: ${{ secrets.PAT_CREATE_PR }}
+          token: ${{ secrets.PAT_CREATE_PR }}

.github/workflows/latest_tags.yml

@@ -18,14 +18,22 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: Install
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: yarn
+
+      - name: Install dependencies
         run: yarn install --frozen-lockfile
-      - name: Build
-        run: BASE_URL='/pr-preview/pr-${{ github.event.number }}/' yarn build
+
+      - name: Build with Base URL
+        run: BASE='/pr-preview/pr-${{ github.event.number }}/' yarn build
+
       - name: Add CNAME file
-        run: echo docs.celestia.org > ./build/CNAME
+        run: mkdir -p ./.vitepress/dist && echo docs.celestia.org > .vitepress/dist/CNAME
 
       - name: Deploy preview
         uses: rossjrw/pr-preview-action@v1
         with:
-          source-dir: ./build/
+          source-dir: .vitepress/dist

.github/workflows/lint.yml

@@ -1,8 +1,10 @@
-.docusaurus/
-build/
-node_modules/
-i18n/
-**/.DS_Store
-.idea/
-.vscode/
-package-lock.json
+.vitepress/dist
+node_modules
+.vitepress/cache/**
+*.log
+*.tgz
+.DS_Store
+.idea
+.temp
+.vite_opt_cache
+.vscode

.github/workflows/preview.yml

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx commitlint --edit $1

.github/workflows/test-deploy.yml

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-npx lint-staged && git add . && git commit --no-verify -m 'Apply linting and formatting'
+npx lint-staged

.gitignore

@@ -0,0 +1 @@
+node_modules/

.husky/commit-msg

@@ -0,0 +1,102 @@
+<template>
+  <div class="center">
+    <button class="keplrButton" @click="add">{{ `Add/switch to ${params.chainName}` }}</button>
+  </div>
+</template>
+
+<script>
+export default {
+  props: ['params'],
+  methods: {
+    async add() {
+      if (!window.keplr) {
+        alert("Please install keplr extension");
+      } else {
+        if (window.keplr.experimentalSuggestChain){
+          try {
+            await window.keplr.experimentalSuggestChain({
+              chainId: this.params.chainId, 
+              chainName: this.params.chainName,
+              rpc: this.params.rpc,
+              rest: this.params.rest,
+              bip44: {
+                coinType: 118,
+              },
+              bech32Config: {
+                bech32PrefixAccAddr: "celestia",
+                bech32PrefixAccPub: "celestia" + "pub",
+                bech32PrefixValAddr: "celestia" + "valoper",
+                bech32PrefixValPub: "celestia" + "valoperpub",
+                bech32PrefixConsAddr: "celestia" + "valcons",
+                bech32PrefixConsPub: "celestia" + "valconspub",
+              },
+              currencies: [ 
+                { 
+                  coinDenom: "TIA", 
+                  coinMinimalDenom: "utia", 
+                  coinDecimals: 6, 
+                  coinGeckoId: "celestia", 
+                }, 
+              ],
+              feeCurrencies: [
+                {
+                  coinDenom: "TIA",
+                  coinMinimalDenom: "utia",
+                  coinDecimals: 6,
+                  coinGeckoId: "celestia",
+                  gasPriceStep: {
+                    low: 0.1,
+                    average: 0.2,
+                    high: 0.4,
+                  },
+                },
+              ],
+              stakeCurrency: {
+                coinDenom: "TIA",
+                coinMinimalDenom: "utia",
+                coinDecimals: 6,
+                coinGeckoId: "celestia",
+              },   
+            }) 
+          } catch {
+            alert("Failed to suggest the chain");
+          }
+        }
+        const chainId = this.params.chainId;
+        await window.keplr.enable(chainId);
+      }
+    }
+  }
+}
+</script>
+
+<style scoped>
+.center {
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  height: 9vh;
+}
+
+.keplrButton {
+  padding: 10px 20px;
+  background-color: #7B2BF9;
+  border: none;
+  color: white;
+  text-align: center;
+  text-decoration: none;
+  display: inline-block;
+  font-size: 16px;
+  margin: 4px 2px;
+  cursor: pointer;
+  border-radius: 4px;
+  transition-duration: 0.4s;
+}
+
+.keplrButton:hover {
+  background-color: #FFFFC5; 
+  color: black; 
+  border: 2px solid #7B2BF9;
+}
+
+</style>