Merge branch 'main' into feat/examples

stardustai · Jul 14, 2024 · 8278fbc · 8278fbc
2 parents c5dfa55 + 85bf8cf
commit 8278fbc
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 6 deletions.
diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml
@@ -0,0 +1,32 @@
+name: 🔂 Surge PR Preview
+
+on: [pull_request]
+
+jobs:
+  preview:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write # allow surge-preview to create/update PR comments
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Action
+        uses: pnpm/action-setup@v3
+        with:
+          version: 8
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - uses: afc163/surge-preview@v1
+        id: preview_step
+        with:
+          surge_token: ${{ secrets.SURGE_TOKEN }}
+          dist: .vitepress/dist
+          build: |
+            pnpm install
+            pnpm build
+      - name: Get the preview_url
+        run: echo "url => ${{ steps.preview_step.outputs.preview_url }}"
diff --git a/.vitepress/config/shared.mts b/.vitepress/config/shared.mts
@@ -128,7 +128,7 @@ export const shared = defineConfig({
           const { info, content } = token
           token.content = ''
           token.hidden = true
-          const title = info.match(/\[(.*)\]/)?.[1]?.toUpperCase() || ''
+          const title = info.match(/\[(.*)\]/)?.[1] || ''
           return rst + template({ title, content })
         }, '')
       }
@@ -137,8 +137,9 @@ export const shared = defineConfig({
         render: (tokens, idx) => {
           if (tokens[idx].nesting === 1) {
             const codeTokens = getTokens(tokens, 'params', idx)
+            const paramKeys = ['body', 'query', 'path', 'form']
             const template = ({ title, content }) => `
-              ["${title}",${content}],
+              ["${title + (paramKeys.includes(title) ? ' params' : '')}",${content}],
             `
             const dataStr = `[
               ${getElements(codeTokens, template).trim().replace(/\,$/, '')}

diff --git a/.vitepress/theme/components/Api/Params/index.vue b/.vitepress/theme/components/Api/Params/index.vue
@@ -1,6 +1,6 @@
 <template>
   <div v-if="result">
-    <h3 class="text-xs font-semibold">{{ title }}</h3>
+    <h3 class="text-xs font-semibold uppercase">{{ title }}</h3>
     <div
       class="bg-[var(--vp-sidebar-bg-color)] rounded-lg border border-gray-200 dark:border-gray-900 border-solid my-4 px-3"
     >
@@ -13,7 +13,7 @@
           })
         "
       >
-        <div class="flex justify-between -mt-1">
+        <div class="flex justify-between">
           <div class="flex items-baseline">
             <span
               v-if="item.required !== false"
@@ -38,7 +38,9 @@
             @change="(val) => handleChange(key, val)"
           />
         </div>
-        <div class="text-xs mt-1">{{ item.description }}</div>
+        <div v-if="item.description" class="text-xs mt-1">
+          {{ item.description }}
+        </div>
       </div>
     </div>
   </div>

diff --git a/.vitepress/theme/components/Api/Results.vue b/.vitepress/theme/components/Api/Results.vue
@@ -1,6 +1,6 @@
 <template>
   <div v-if="result">
-    <h3 class="text-xs font-semibold">{{ title }}</h3>
+    <h3 class="text-xs font-semibold uppercase">{{ title }}</h3>
     <div
       class="bg-[var(--vp-sidebar-bg-color)] rounded-lg border border-gray-200 dark:border-gray-900 border-solid my-4"
     >