feat: 🎸 initial commit

Author: pileax

.github/workflows/deploy.yml

@@ -0,0 +1,67 @@
+# 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]
+
+  # 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
+      - name: Install pnpm
+        run: npm i pnpm -g
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Install dependencies
+        run: pnpm install
+      - name: Build with VitePress
+        run: |
+          pnpm docs:build
+          touch .vitepress/dist/.nojekyll
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: .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,23 @@
+.DS_Store
+.thumbs.db
+node_modules
+
+# Cache
+dist
+.vitepress/cache
+
+# Log files
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Editor directories and files
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.iml
+
+# local .env files
+.env.local*

.vitepress/config/common.mts

@@ -0,0 +1,45 @@
+import { defineConfig } from 'vitepress'
+import { tabsMarkdownPlugin } from 'vitepress-plugin-tabs'
+import { keywords, name, repo } from '../meta'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  srcDir: './src',
+  cleanUrls: true,
+  ignoreDeadLinks: true,
+  lastUpdated: true,
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    logo: '/logo.svg',
+    search: {
+      provider: 'local',
+      // options: {
+      //   appId: 'LBLWR2QCI3',
+      //   apiKey: '4338f265da64e33025f821af827dd22e',
+      //   indexName: 'pileax'
+      // }
+    },
+    outline: 'deep',
+    socialLinks: [
+      { icon: 'github', link: repo },
+    ],
+    footer: {
+      message: 'MIT Licensed.',
+      copyright: `Copyright © 2024-present ${name}`
+    },
+  },
+
+  head: [
+    ['link', { rel: 'icon', type: 'image/svg+xml', href: '/logo.svg' }],
+    ['meta', { name: 'keywords', content: keywords }],
+  ],
+
+  markdown: {
+    config(md) {
+      md.use(tabsMarkdownPlugin)
+    }
+  },
+
+  optimizeDeps: {
+  }
+})

.vitepress/config/en.mts

@@ -0,0 +1,26 @@
+import { defineConfig } from 'vitepress'
+import { nav } from './theme/nav'
+import { sidebarGuide, sidebarApi } from './theme/sidebar'
+import { labels } from './theme/labels'
+import { name, description, docsRepo } from '../meta'
+
+const locale = 'en';
+
+export default defineConfig({
+  title: name,
+  description: description,
+  themeConfig: {
+    ...labels(locale),
+    nav: nav(locale),
+    sidebar: {
+      '/guide/': { base: '/guide/', items: sidebarGuide(locale) },
+      '/api/': { base: '/api/', items: sidebarApi(locale) },
+    },
+    editLink: {
+      pattern: `${docsRepo}/edit/main/src/:path`,
+      text: "Edit this page",
+    },
+  },
+  head: [
+  ],
+})

.vitepress/config/index.mts

@@ -0,0 +1,21 @@
+import { defineConfig } from 'vitepress'
+import commonConfig from './common.mjs'
+import enConfig from './en.mjs'
+import zhConfig from './zh.mjs'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  ...commonConfig,
+  locales: {
+    root: {
+      label: 'English',
+      lang: 'en',
+      ...enConfig
+    },
+    zh: {
+      label: '中文',
+      lang: 'zh',
+      ...zhConfig
+    }
+  }
+})

.vitepress/config/theme/labels.ts

@@ -0,0 +1,18 @@
+import { tr } from '../../i18n';
+
+export function labels(locale :string) {
+  const t = (key :string) => {
+    return tr(locale, `theme.${key}`)
+  }
+  return {
+    docFooter: {
+      prev: t('prev'),
+      next: t('next'),
+    },
+    returnToTopLabel: t('returnToTop'),
+    outlineTitle: t('outline'),
+    darkModeSwitchLabel: t('darkModeSwitch'),
+    sidebarMenuLabel: t('sidebarMenu'),
+    lastUpdatedText: t('lastUpdated'),
+  }
+}

.vitepress/config/theme/nav.ts

@@ -0,0 +1,23 @@
+import { tr } from '../../i18n'
+import { preview } from '../../meta'
+import { DefaultTheme } from "vitepress";
+
+export function nav(locale :string) {
+  const t = (key :string) => {
+    return tr(locale, `nav.${key}`)
+  }
+  const base = (locale === 'en') ? '' : `/${locale}`;
+  return [
+    { text: t('guide'), link: base + '/guide/getting-started' },
+    { text: 'API', link: base + '/api/component/overview' },
+    { text: t('demo'), link: base + '/demo/vue' },
+    // {
+    //   text: 'Demos',
+    //   items: [
+    //     { text: 'Vue', link: base + '/demo/vue' },
+    //     { text: 'React', link: base + '/demo/react' },
+    //   ]
+    // },
+    { text: t('preview'), link: preview },
+  ] as DefaultTheme.NavItem[];
+}

.vitepress/config/theme/sidebar.ts

@@ -0,0 +1,101 @@
+import { tr } from '../../i18n';
+
+export function sidebarGuide(locale :string) {
+  const t = (key :string) => {
+    return tr(locale, `sidebar.guide.${key}`);
+  }
+  return [
+    {
+      text: t('guide'),
+      collapsed: false,
+      items: [
+        { text: t('introduction'), link: 'introduction' },
+        { text: t('gettingStarted'), link: 'getting-started' },
+        { text: t('styles'), link: 'styles' },
+      ]
+    },
+    // {
+    //   text: t('utilities'),
+    //   collapsed: true,
+    //   items: [
+    //     { text: 'Emoji', link: 'util/emoji' },
+    //     { text: t('icon'), link: 'util/icon' },
+    //   ]
+    // },
+  ]
+}
+export function sidebarApi(locale :string) {
+  const t = (key :string) => {
+    return tr(locale, `sidebar.api.${key}`);
+  }
+  const vueComponent = (path :string) => {
+    return `component/vue/${path}`;
+  }
+  const reactComponent = (path :string) => {
+    return `component/react/${path}`;
+  }
+  const extension = (path :string) => {
+    return `extension/${path}`;
+  }
+  return [
+    {
+      text: t('components'),
+      collapsed: false,
+      items: [
+        { text: t('overview'), link: 'component/overview' },
+        {
+          text: 'Vue',
+          collapsed: false,
+          items: [
+            { text: 'YiiEditor', link: vueComponent('yii-editor') },
+            {
+              text: 'Common',
+              collapsed: false,
+              items: [
+                { text: 'Doc TOC', link: vueComponent('common/doc-toc') },
+              ]
+            },
+            {
+              text: 'Menus',
+              collapsed: false,
+              items: [
+                { text: 'OMainMenu', link: vueComponent('menus/main-menu') },
+              ]
+            },
+            {
+              text: 'UI',
+              collapsed: true,
+              items: [
+                { text: 'OIcon', link: vueComponent('ui/icon') },
+              ]
+            },
+          ]
+        },
+        {
+          text: 'React',
+          collapsed: false,
+          items: [
+            { text: 'YiiEditor', link: reactComponent('yii-editor') },
+          ]
+        },
+      ]
+    },
+    {
+      text: t('extensions'),
+      collapsed: false,
+      items: [
+        { text: t('overview'), link: extension('overview') },
+        { text: 'Callout', link: extension('callout') },
+        { text: 'Char Command', link: extension('char-command') },
+        { text: 'Code Block', link: extension('code-block') },
+        { text: 'Color Highlighter', link: extension('color-highlighter') },
+        { text: 'Image', link: extension('image') },
+        { text: 'Placeholder', link: extension('placeholder') },
+        { text: 'Table', link: extension('table') },
+        { text: 'Trailing Node', link: extension('trailing-node') },
+        { text: 'Unique ID', link: extension('unique-id') },
+        { text: 'Video', link: extension('video') },
+      ]
+    },
+  ]
+}

.vitepress/config/zh.mts

@@ -0,0 +1,26 @@
+import { defineConfig } from 'vitepress'
+import { nav } from './theme/nav'
+import { sidebarGuide, sidebarApi } from './theme/sidebar'
+import { labels } from './theme/labels'
+import { name, docsRepo, descriptionZh } from '../meta'
+
+const locale = 'zh';
+
+export default defineConfig({
+  title: name,
+  description: descriptionZh,
+  themeConfig: {
+    ...labels(locale),
+    nav: nav(locale),
+    sidebar: {
+      '/zh/guide/': { base: '/zh/guide/', items: sidebarGuide(locale) },
+      '/zh/api/': { base: '/zh/api/', items: sidebarApi(locale) },
+    },
+    editLink: {
+      pattern: `${docsRepo}/edit/main/src/:path`,
+      text: "编辑此页",
+    },
+  },
+  head: [
+  ],
+})