Initial commit VitePress documentation site

Author: Leon998

InterDataEngine-docs/.github/workflows/deploy.yml

@@ -0,0 +1,55 @@
+name: Deploy VitePress site to Pages
+
+on:
+  push:
+    branches: [master]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+      
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      
+      - name: Install dependencies
+        run: npm ci
+      
+      - name: Build with VitePress
+        run: npm run build
+      
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: .vitepress/dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

InterDataEngine-docs/.gitignore

@@ -0,0 +1,21 @@
+# Dependencies
+node_modules/
+
+# Build output
+.vitepress/dist/
+.vitepress/cache/
+
+# Editor directories
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Logs
+*.log
+npm-debug.log*

InterDataEngine-docs/.vitepress/config.js

@@ -0,0 +1,114 @@
+import { defineConfig } from 'vitepress'
+import { katex } from '@mdit/plugin-katex'
+
+export default defineConfig({
+  title: 'InternDataEngine',
+  base: '/InternDataEngine-Docs/',
+  
+  themeConfig: {
+    logo: '/logo.svg',
+    
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Getting Started', link: '/guides/installation' },
+      { text: 'Core Concepts', link: '/concepts/workflows' },
+      { text: 'Policy Validation', link: '/policy/training' }
+    ],
+    
+    sidebar: [
+      {
+        text: 'Getting Started',
+        items: [
+          { text: 'Installation', link: '/guides/installation' },
+          { text: 'Quick Start', link: '/guides/quickstart' }
+        ]
+      },
+      {
+        text: 'Core Concepts',
+        items: [
+          { text: 'Workflows', link: '/concepts/workflows' },
+          {
+            text: 'Skills',
+            collapsed: true,
+            items: [
+              { text: 'Overview', link: '/concepts/skills/overview' },
+              { text: 'Pick Skill', link: '/concepts/skills/pick' },
+              { text: 'Place Skill', link: '/concepts/skills/place' },
+              { text: 'Articulation Skill', link: '/concepts/skills/articulation' }
+            ]
+          },
+          { text: 'Objects', link: '/concepts/objects' },
+          { text: 'Cameras', link: '/concepts/cameras' },
+          { text: 'Robots', link: '/concepts/robots' },
+          { text: 'Controllers', link: '/concepts/controllers' }
+        ]
+      },
+      {
+        text: 'Configuration',
+        items: [
+          { text: 'YAML Config', link: '/config/yaml' },
+          { text: 'Domain Randomization', link: '/config/dr' },
+          { text: 'Assets', link: '/config/assets' }
+        ]
+      },
+      {
+        text: 'Customization',
+        items: [
+          { text: 'New Assets', link: '/custom/assets' },
+          { text: 'New Robot', link: '/custom/robot' },
+          { text: 'New Controller', link: '/custom/controller' },
+          { text: 'New Skill', link: '/custom/skill' },
+          { text: 'New Task', link: '/custom/task' }
+        ]
+      },
+      {
+        text: 'Policy Validation',
+        items: [
+          { text: 'Training', link: '/policy/training' }
+        ]
+      }
+    ],
+    
+    footer: {
+      message: 'Released under the MIT License.',
+      copyright: 'Copyright © 2024 InternDataEngine Team'
+    },
+    
+    docFooter: {
+      prev: 'Previous Page',
+      next: 'Next Page'
+    },
+    
+    outline: {
+      label: 'On this page',
+      level: [2, 3]
+    },
+    
+    lastUpdated: {
+      text: 'Last updated',
+      formatOptions: {
+        dateStyle: 'medium',
+        timeStyle: 'short'
+      }
+    },
+    
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/InternRobotics/InternDataEngine' }
+    ],
+    
+    search: {
+      provider: 'local'
+    }
+  },
+  
+  markdown: {
+    lineNumbers: true,
+    config: (md) => {
+      md.use(katex)
+    }
+  },
+  
+  head: [
+    ['link', { rel: 'stylesheet', href: 'https://cdn.jsdelivr.net/npm/katex@0.16.9/dist/katex.min.css' }]
+  ]
+})

InterDataEngine-docs/.vitepress/theme/index.js

@@ -0,0 +1,79 @@
+import DefaultTheme from 'vitepress/theme'
+import './style.css'
+
+export default {
+  ...DefaultTheme,
+  setup() {
+    // Add drag-to-scroll for code blocks
+    if (typeof window !== 'undefined') {
+      setTimeout(() => {
+        const codeBlocks = document.querySelectorAll('.vp-doc [class*="language-"]')
+        codeBlocks.forEach(block => {
+          let isDown = false
+          let startX
+          let scrollLeft
+
+          block.style.cursor = 'grab'
+
+          block.addEventListener('mousedown', (e) => {
+            isDown = true
+            block.style.cursor = 'grabbing'
+            startX = e.pageX - block.offsetLeft
+            scrollLeft = block.scrollLeft
+          })
+
+          block.addEventListener('mouseleave', () => {
+            isDown = false
+            block.style.cursor = 'grab'
+          })
+
+          block.addEventListener('mouseup', () => {
+            isDown = false
+            block.style.cursor = 'grab'
+          })
+
+          block.addEventListener('mousemove', (e) => {
+            if (!isDown) return
+            e.preventDefault()
+            const x = e.pageX - block.offsetLeft
+            const walk = (x - startX) * 1.5
+            block.scrollLeft = scrollLeft - walk
+          })
+        })
+
+        // Add click-to-zoom for images
+        const images = document.querySelectorAll('.vp-doc img')
+        images.forEach(img => {
+          img.addEventListener('click', () => {
+            // Create overlay
+            const overlay = document.createElement('div')
+            overlay.className = 'image-zoom-overlay'
+
+            // Create zoomed image
+            const zoomedImg = document.createElement('img')
+            zoomedImg.src = img.src
+
+            overlay.appendChild(zoomedImg)
+            document.body.appendChild(overlay)
+
+            // Close on click
+            overlay.addEventListener('click', () => {
+              document.body.removeChild(overlay)
+            })
+
+            // Close on escape key
+            const handleEsc = (e) => {
+              if (e.key === 'Escape') {
+                if (document.body.contains(overlay)) {
+                  document.body.removeChild(overlay)
+                }
+                document.removeEventListener('keydown', handleEsc)
+              }
+            }
+            document.addEventListener('keydown', handleEsc)
+          })
+        })
+      }, 500)
+    }
+  }
+}