📝 rubick 文档

.github/workflows/deploy.yml

@@ -0,0 +1,66 @@
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy rubick 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: [master]
+
+  # 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:
+  contents: read
+  pages: write
+  id-token: write
+
+# 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:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      # - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
+      # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: npm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Install dependencies
+        run: npm ci # or pnpm install / yarn install / bun install
+      - name: Build with VitePress
+        run: |
+          npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
+          touch docs/.vitepress/dist/.nojekyll
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: docs/.vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -0,0 +1,21 @@
+.DS_Store
+node_modules
+/build
+.vitepress/dist
+.vitepress/cache
+
+
+# Log files
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# Editor directories and files
+.idea
+.vscode
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

.vitepress/config.mjs

@@ -0,0 +1,50 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  base: '/docs/',
+  title: "rubick 文档",
+  description: "rubick 官方文档",
+  head: [
+    ['link', { rel: 'icon', type: 'image/svg+xml', href: 'https://picx.zhimg.com/80/v2-3d6a948772386c47f311a3d64d9fe70a_720w.png' }],
+    ['link', { rel: 'icon', type: 'image/png', href: 'https://picx.zhimg.com/80/v2-3d6a948772386c47f311a3d64d9fe70a_720w.png' }],
+  ],
+  themeConfig: {
+    logo: { src: 'https://picx.zhimg.com/80/v2-3d6a948772386c47f311a3d64d9fe70a_720w.png', width: 24, height: 24 },
+
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: '官网', link: 'https://rubick.vip' },
+      { text: '使用说明', link: '/guide/index.md' }
+    ],
+
+    sidebar: [
+      {
+        text: '指南',
+        items: [
+          { text: '介绍', link: '/guide/index.md' },
+          { text: '操作指南', link: '/guide/usage.md' },
+          { text: '赞助', link: '/sponsor/index.md' },
+        ]
+      },
+      {
+        text: '开发者文档',
+        items: [
+          { text: '插件开发', link: '/dev/index.md' },
+          { text: '插件 API', link: '/dev/api.md' },
+          { text: '主程序开发', link: '/dev/dev.md' }
+        ]
+      },
+      {
+        text: 'rubick 源码介绍篇',
+        items: [
+          { text: '源码介绍', link: '/core/index.md' },
+        ]
+      },
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
+    ]
+  }
+})

api-examples.md

@@ -0,0 +1,49 @@
+---
+outline: deep
+---
+
+# Runtime API Examples
+
+This page demonstrates usage of some of the runtime APIs provided by VitePress.
+
+The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files:
+
+```md
+<script setup>
+import { useData } from 'vitepress'
+
+const { theme, page, frontmatter } = useData()
+</script>
+
+## Results
+
+### Theme Data
+<pre>{{ theme }}</pre>
+
+### Page Data
+<pre>{{ page }}</pre>
+
+### Page Frontmatter
+<pre>{{ frontmatter }}</pre>
+```
+
+<script setup>
+import { useData } from 'vitepress'
+
+const { site, theme, page, frontmatter } = useData()
+</script>
+
+## Results
+
+### Theme Data
+<pre>{{ theme }}</pre>
+
+### Page Data
+<pre>{{ page }}</pre>
+
+### Page Frontmatter
+<pre>{{ frontmatter }}</pre>
+
+## More
+
+Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata).

core/index.md

@@ -0,0 +1,3 @@
+# 源码介绍
+
+> WIP