From e4d3969e95a8cdc7e024e291562e9c66660b3cd0 Mon Sep 17 00:00:00 2001 From: landaiqing Date: Mon, 3 Nov 2025 22:49:38 +0800 Subject: [PATCH] :pencil: Build document directory structure --- frontend/docs/.vitepress/config.ts | 173 +++++++++++------- frontend/docs/src/api-examples.md | 49 ----- frontend/docs/src/guide/features.md | 163 +++++++++++++++++ frontend/docs/src/guide/getting-started.md | 110 +++++++++++ frontend/docs/src/guide/installation.md | 63 +++++++ frontend/docs/src/guide/introduction.md | 50 +++++ frontend/docs/src/index.md | 56 ++++-- frontend/docs/src/markdown-examples.md | 85 --------- frontend/docs/src/zh/guide/features.md | 163 +++++++++++++++++ frontend/docs/src/zh/guide/getting-started.md | 110 +++++++++++ frontend/docs/src/zh/guide/installation.md | 63 +++++++ frontend/docs/src/zh/guide/introduction.md | 50 +++++ frontend/docs/src/zh/index.md | 56 ++++++ 13 files changed, 974 insertions(+), 217 deletions(-) delete mode 100644 frontend/docs/src/api-examples.md create mode 100644 frontend/docs/src/guide/features.md create mode 100644 frontend/docs/src/guide/getting-started.md create mode 100644 frontend/docs/src/guide/installation.md create mode 100644 frontend/docs/src/guide/introduction.md delete mode 100644 frontend/docs/src/markdown-examples.md create mode 100644 frontend/docs/src/zh/guide/features.md create mode 100644 frontend/docs/src/zh/guide/getting-started.md create mode 100644 frontend/docs/src/zh/guide/installation.md create mode 100644 frontend/docs/src/zh/guide/introduction.md create mode 100644 frontend/docs/src/zh/index.md diff --git a/frontend/docs/.vitepress/config.ts b/frontend/docs/.vitepress/config.ts index cc0a314..d4c244c 100644 --- a/frontend/docs/.vitepress/config.ts +++ b/frontend/docs/.vitepress/config.ts @@ -4,7 +4,6 @@ import {defineConfig} from 'vitepress' export default defineConfig({ title: "voidraft", description: "An elegant text snippet recording tool designed for developers.", - lang: 'zh-CN', srcDir: 'src', assetsDir: 'assets', cacheDir: './.vitepress/cache', @@ -12,75 +11,111 @@ export default defineConfig({ srcExclude: [], ignoreDeadLinks: false, head: [ - [ - "link", - { - rel: "icon", - type: "image/png", - href: "/static/icon/favicon-96x96.png", - sizes: "96x96", - }, - ], - [ - "link", - { - rel: "icon", - type: "image/svg+xml", - href: "/static/icon/favicon.svg", - }, - ], - [ - "link", - { - rel: "shortcut icon", - href: "/static/icon/favicon.ico", - }, - ], - [ - "link", - { - rel: "apple-touch-icon", - sizes: "180x180", - href: "/static/icon/apple-touch-icon.png", - }, - ], - [ - "meta", - { - name: "apple-mobile-web-app-title", - content: "voidraft", - }, - ], - [ - "link", - { - rel: "manifest", - href: "/static/icon/site.webmanifest", - }, - ], - ['meta', {name: 'viewport', content: 'width=device-width,initial-scale=1'}] + ["link", { rel: "icon", type: "image/png", href: "/static/icon/favicon-96x96.png", sizes: "96x96" }], + ["link", { rel: "icon", type: "image/svg+xml", href: "/static/icon/favicon.svg" }], + ["link", { rel: "shortcut icon", href: "/static/icon/favicon.ico" }], + ["link", { rel: "apple-touch-icon", sizes: "180x180", href: "/static/icon/apple-touch-icon.png" }], + ["meta", { name: "apple-mobile-web-app-title", content: "voidraft" }], + ["link", { rel: "manifest", href: "/static/icon/site.webmanifest" }], + ['meta', { name: 'viewport', content: 'width=device-width,initial-scale=1' }] ], - themeConfig: { - logo: '/static/icon/logo.png', - siteTitle: 'voidraft', - // https://vitepress.dev/reference/default-theme-config - nav: [ - {text: 'Home', link: '/'}, - {text: 'Examples', link: '/markdown-examples'} - ], - - sidebar: [ - { - text: 'Examples', - items: [ - {text: 'Markdown Examples', link: '/markdown-examples'}, - {text: 'Runtime API Examples', link: '/api-examples'} - ] + + // 国际化配置 + locales: { + root: { + label: 'English', + lang: 'en-US', + description: 'An elegant text snippet recording tool designed for developers.', + themeConfig: { + logo: '/static/icon/logo.png', + siteTitle: 'voidraft', + nav: [ + {text: 'Home', link: '/'}, + {text: 'Guide', link: '/guide/introduction'} + ], + sidebar: { + '/guide/': [ + { + text: 'Getting Started', + items: [ + {text: 'Introduction', link: '/guide/introduction'}, + {text: 'Installation', link: '/guide/installation'}, + {text: 'Quick Start', link: '/guide/getting-started'} + ] + }, + { + text: 'Features', + items: [ + {text: 'Overview', link: '/guide/features'} + ] + } + ] + }, + socialLinks: [ + {icon: 'github', link: 'https://github.com/landaiqing/voidraft'} + ], + outline: { + label: 'On this page' + }, + lastUpdated: { + text: 'Last updated' + }, + docFooter: { + prev: 'Previous', + next: 'Next' + }, + darkModeSwitchLabel: 'Appearance', + sidebarMenuLabel: 'Menu', + returnToTopLabel: 'Return to top' } - ], - - socialLinks: [ - {icon: 'github', link: 'https://github.com/landaiqing/voidraft'} - ] + }, + zh: { + label: '简体中文', + lang: 'zh-CN', + link: '/zh/', + description: '一个为开发者设计的优雅文本片段记录工具', + themeConfig: { + logo: '/static/icon/logo.png', + siteTitle: 'voidraft', + nav: [ + {text: '首页', link: '/zh/'}, + {text: '指南', link: '/zh/guide/introduction'} + ], + sidebar: { + '/zh/guide/': [ + { + text: '开始使用', + items: [ + {text: '简介', link: '/zh/guide/introduction'}, + {text: '安装', link: '/zh/guide/installation'}, + {text: '快速开始', link: '/zh/guide/getting-started'} + ] + }, + { + text: '功能特性', + items: [ + {text: '功能概览', link: '/zh/guide/features'} + ] + } + ] + }, + socialLinks: [ + {icon: 'github', link: 'https://github.com/landaiqing/voidraft'} + ], + outline: { + label: '本页目录' + }, + lastUpdated: { + text: '最后更新' + }, + docFooter: { + prev: '上一页', + next: '下一页' + }, + darkModeSwitchLabel: '外观', + sidebarMenuLabel: '菜单', + returnToTopLabel: '返回顶部' + } + } } }) diff --git a/frontend/docs/src/api-examples.md b/frontend/docs/src/api-examples.md deleted file mode 100644 index 6bd8bb5..0000000 --- a/frontend/docs/src/api-examples.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -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 - - -## Results - -### Theme Data -
{{ theme }}
- -### Page Data -
{{ page }}
- -### Page Frontmatter -
{{ frontmatter }}
-``` - - - -## Results - -### Theme Data -
{{ theme }}
- -### Page Data -
{{ page }}
- -### Page Frontmatter -
{{ frontmatter }}
- -## More - -Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata). diff --git a/frontend/docs/src/guide/features.md b/frontend/docs/src/guide/features.md new file mode 100644 index 0000000..7b9a446 --- /dev/null +++ b/frontend/docs/src/guide/features.md @@ -0,0 +1,163 @@ +# Features + +Explore the powerful features that make voidraft a great tool for developers. + +## Block-Based Editing + +voidraft's core feature is its block-based editing system: + +- Each block can have a different programming language +- Blocks are separated by delimiters (`∞∞∞language`) +- Navigate quickly between blocks +- Format each block independently + +## Syntax Highlighting + +Professional syntax highlighting for 30+ languages: + +- Automatic language detection +- Customizable color schemes +- Support for nested languages +- Code folding support + +## HTTP Client + +Built-in HTTP client for API testing: + +### Request Types +- GET, POST, PUT, DELETE, PATCH +- Custom headers +- Multiple body formats: JSON, FormData, URL-encoded, XML, Text + +### Request Variables +Define and reuse variables: + +```http +@var { + baseUrl: "https://api.example.com", + token: "your-api-token" +} + +GET "{{baseUrl}}/users" { + authorization: "Bearer {{token}}" +} +``` + +### Response Handling +- View formatted JSON responses +- See response time and size +- Inspect headers +- Save responses for later + +## Code Formatting + +Integrated Prettier support: + +- Format on save (optional) +- Format selection or entire block +- Supports JavaScript, TypeScript, CSS, HTML, JSON, and more +- Customizable formatting rules + +## Editor Extensions + +### VSCode-Style Search +- Find and replace with regex support +- Case-sensitive and whole word options +- Search across all blocks + +### Minimap +- Bird's-eye view of your document +- Quick navigation +- Customizable size and position + +### Rainbow Brackets +- Color-coded bracket pairs +- Easier to match brackets +- Customizable colors + +### Color Picker +- Visual color selection +- Supports hex, RGB, HSL +- Live preview + +### Translation Tool +- Translate selected text +- Multiple language support +- Quick keyboard access + +### Text Highlighting +- Highlight important text +- Multiple highlight colors +- Persistent highlights + +## Multi-Window Support + +Work efficiently with multiple windows: + +- Each window is independent +- Separate documents +- Synchronized settings +- Window state persistence + +## Theme Customization + +Full control over editor appearance: + +### Built-in Themes +- Dark mode +- Light mode +- Auto-switch based on system + +### Custom Themes +- Create your own themes +- Customize every color +- Save and share themes +- Import community themes + +## Auto-Update System + +Stay current with automatic updates: + +- Background update checks +- Notification of new versions +- One-click update +- Update history +- Support for multiple update sources (GitHub, Gitea) + +## Data Backup + +Secure your data with Git-based backup: + +- Automatic backups +- Manual backup triggers +- Support for GitHub and Gitea +- Multiple authentication methods (SSH, Token, Password) +- Configurable backup intervals + +## Keyboard Shortcuts + +Extensive keyboard support: + +- Customizable shortcuts +- Vim/Emacs keybindings (planned) +- Quick command palette +- Context-aware shortcuts + +## Performance + +Built for speed: + +- Fast startup time +- Smooth scrolling +- Efficient memory usage +- Large file support + +## Privacy & Security + +Your data is safe: + +- Local-first storage +- Optional cloud backup +- No telemetry or tracking +- Open source codebase + diff --git a/frontend/docs/src/guide/getting-started.md b/frontend/docs/src/guide/getting-started.md new file mode 100644 index 0000000..d3c2084 --- /dev/null +++ b/frontend/docs/src/guide/getting-started.md @@ -0,0 +1,110 @@ +# Getting Started + +Learn the basics of using voidraft and create your first document. + +## The Editor Interface + +When you open voidraft, you'll see: + +- **Main Editor**: The central area where you write and edit +- **Toolbar**: Quick access to common actions +- **Status Bar**: Shows current block language and other info + +## Creating Code Blocks + +voidraft uses a block-based editing system. Each block can have a different language: + +1. Press `Ctrl+Enter` to create a new block +2. Type `∞∞∞` followed by a language name (e.g., `∞∞∞javascript`) +3. Start coding in that block + +### Supported Languages + +voidraft supports 30+ programming languages including: +- JavaScript, TypeScript +- Python, Go, Rust +- HTML, CSS, Sass +- SQL, YAML, JSON +- And many more... + +## Basic Operations + +### Navigation + +- `Ctrl+Up/Down`: Move between blocks +- `Ctrl+Home/End`: Jump to first/last block +- `Ctrl+F`: Search within document + +### Editing + +- `Ctrl+D`: Duplicate current line +- `Ctrl+/`: Toggle comment +- `Alt+Up/Down`: Move line up/down +- `Ctrl+Shift+F`: Format code (if language supports Prettier) + +### Block Management + +- `Ctrl+Enter`: Create new block +- `Ctrl+Shift+Enter`: Create block above +- `Alt+Delete`: Delete current block + +## Using the HTTP Client + +voidraft includes a built-in HTTP client for testing APIs: + +1. Create a block with HTTP language +2. Write your HTTP request: + +```http +POST "https://api.example.com/users" { + content-type: "application/json" + + @json { + name: "John Doe", + email: "john@example.com" + } +} +``` + +3. Click the run button to execute the request +4. View the response inline + +## Multi-Window Support + +Work on multiple documents simultaneously: + +1. Go to `File > New Window` (or `Ctrl+Shift+N`) +2. Each window is independent +3. Changes are saved automatically + +## Customizing Themes + +Personalize your editor: + +1. Open Settings (`Ctrl+,`) +2. Go to Appearance +3. Choose a theme or create your own +4. Customize colors to your preference + +## Keyboard Shortcuts + +Learn essential shortcuts: + +| Action | Shortcut | +|--------|----------| +| New Window | `Ctrl+Shift+N` | +| Search | `Ctrl+F` | +| Replace | `Ctrl+H` | +| Format Code | `Ctrl+Shift+F` | +| Toggle Theme | `Ctrl+Shift+T` | +| Command Palette | `Ctrl+Shift+P` | + +## Next Steps + +Now that you know the basics: + +- Explore [Features](/guide/features) in detail +- Set up [Git Backup](/guide/backup) for your data +- Learn about [Extensions](/guide/extensions) +- Configure [Settings](/guide/settings) + diff --git a/frontend/docs/src/guide/installation.md b/frontend/docs/src/guide/installation.md new file mode 100644 index 0000000..fac2d76 --- /dev/null +++ b/frontend/docs/src/guide/installation.md @@ -0,0 +1,63 @@ +# Installation + +This guide will help you install voidraft on your system. + +## System Requirements + +- **Operating System**: Windows 10 or later (macOS and Linux support planned) +- **RAM**: 4GB minimum, 8GB recommended +- **Disk Space**: 200MB free space + +## Download + +Visit the [releases page](https://github.com/landaiqing/voidraft/releases) and download the latest version for your platform: + +- **Windows**: `voidraft-windows-amd64-installer.exe` + +## Installation Steps + +### Windows + +1. Download the installer from the releases page +2. Run the `voidraft-windows-amd64-installer.exe` file +3. Follow the installation wizard +4. Launch voidraft from the Start menu or desktop shortcut + +## First Launch + +When you first launch voidraft: + +1. The application will create a data directory to store your documents +2. You'll see the main editor interface with a welcome block +3. Start typing or create your first code block! + +## Configuration + +voidraft stores its configuration and data in: + +- **Windows**: `%APPDATA%/voidraft/` + +You can customize various settings including: +- Editor theme (dark/light mode) +- Code formatting preferences +- Backup settings +- Keyboard shortcuts + +## Updating + +voidraft includes an auto-update feature that will notify you when new versions are available. You can: + +- Check for updates manually from the settings +- Enable automatic updates +- Choose your preferred update source + +## Troubleshooting + +If you encounter any issues during installation: + +1. Make sure you have administrator privileges +2. Check that your antivirus isn't blocking the installation +3. Visit our [GitHub issues](https://github.com/landaiqing/voidraft/issues) page for help + +Next: [Getting Started →](/guide/getting-started) + diff --git a/frontend/docs/src/guide/introduction.md b/frontend/docs/src/guide/introduction.md new file mode 100644 index 0000000..f09d594 --- /dev/null +++ b/frontend/docs/src/guide/introduction.md @@ -0,0 +1,50 @@ +# Introduction + +Welcome to voidraft - an elegant text snippet recording tool designed specifically for developers. + +## What is voidraft? + +voidraft is a modern desktop application that helps developers manage text snippets, code blocks, API responses, meeting notes, and daily to-do lists. It provides a smooth and elegant editing experience with powerful features tailored for development workflows. + +## Key Features + +### Block-Based Editing + +voidraft uses a unique block-based editing system inspired by Heynote. You can split your content into independent code blocks, each with: +- Different programming language settings +- Syntax highlighting +- Independent formatting +- Easy navigation between blocks + +### Developer Tools + +- **HTTP Client**: Test APIs directly within the editor +- **Code Formatting**: Built-in Prettier support for multiple languages +- **Syntax Highlighting**: Support for 30+ programming languages +- **Auto Language Detection**: Automatically recognizes code block language types + +### Customization + +- **Custom Themes**: Create and save your own editor themes +- **Extensions**: Rich set of editor extensions including minimap, rainbow brackets, color picker, and more +- **Multi-Window**: Work on multiple documents simultaneously + +### Data Management + +- **Git-Based Backup**: Automatic backup using Git repositories +- **Cloud Sync**: Sync your data across devices +- **Auto-Update**: Stay up-to-date with the latest features + +## Why voidraft? + +- **Developer-Focused**: Built with developers' needs in mind +- **Modern Stack**: Uses cutting-edge technologies (Wails3, Vue 3, CodeMirror 6) +- **Cross-Platform**: Works on Windows (macOS and Linux support planned) +- **Open Source**: MIT licensed, community-driven development + +## Getting Started + +Ready to start? Download the latest version from our [releases page](https://github.com/landaiqing/voidraft/releases) or continue reading the documentation to learn more. + +Next: [Installation →](/guide/installation) + diff --git a/frontend/docs/src/index.md b/frontend/docs/src/index.md index 1504cc0..3c0a87a 100644 --- a/frontend/docs/src/index.md +++ b/frontend/docs/src/index.md @@ -1,28 +1,56 @@ --- -# https://vitepress.dev/reference/default-theme-home-page layout: home hero: name: "voidraft" - text: "An elegant text snippet recording tool designed for developers." - tagline: My great project tagline + text: "An elegant text snippet recording tool" + tagline: Designed for developers, built with modern technology image: src: /static/img/hero.png alt: "voidraft" actions: - theme: brand - text: Markdown Examples - link: /markdown-examples + text: Get Started + link: https://github.com/landaiqing/voidraft/releases - theme: alt - text: API Examples - link: /api-examples + text: Documentation + link: /guide/introduction features: - - title: Feature A - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit - - title: Feature B - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit - - title: Feature C - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit ---- + - icon: 📝 + title: Block-Based Editing + details: Split your content into independent code blocks, each with different language settings. Inspired by Heynote's innovative design philosophy. + + - icon: 🎨 + title: Syntax Highlighting + details: Built-in support for 30+ programming languages with automatic language detection and Prettier integration for code formatting. + + - icon: 🌐 + title: HTTP Client + details: Integrated HTTP client with support for multiple request formats including JSON, FormData, XML, and more. Test APIs directly within the editor. + + - icon: 🎯 + title: Multi-Window Support + details: Work on multiple documents simultaneously with independent windows. Each window maintains its own state and configuration. + + - icon: 🎭 + title: Customizable Themes + details: Full theme customization support with dark/light modes. Create and save your own editor themes to match your preferences. + + - icon: 🔧 + title: Rich Extensions + details: VSCode-style search and replace, rainbow brackets, minimap, color picker, translation tool, text highlighting, and more. + + - icon: 🔄 + title: Auto-Update System + details: Built-in self-update mechanism with support for multiple update sources. Stay up-to-date with the latest features and improvements. + + - icon: ☁️ + title: Git-Based Backup + details: Automatic data backup using Git repositories. Supports GitHub, Gitea, with multiple authentication methods including SSH and tokens. + + - icon: ⚡ + title: Modern Architecture + details: Built with Wails3, Vue 3, and CodeMirror 6. Cross-platform desktop application with native performance and modern UI. +--- \ No newline at end of file diff --git a/frontend/docs/src/markdown-examples.md b/frontend/docs/src/markdown-examples.md deleted file mode 100644 index f9258a5..0000000 --- a/frontend/docs/src/markdown-examples.md +++ /dev/null @@ -1,85 +0,0 @@ -# Markdown Extension Examples - -This page demonstrates some of the built-in markdown extensions provided by VitePress. - -## Syntax Highlighting - -VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting: - -**Input** - -````md -```js{4} -export default { - data () { - return { - msg: 'Highlighted!' - } - } -} -``` -```` - -**Output** - -```js{4} -export default { - data () { - return { - msg: 'Highlighted!' - } - } -} -``` - -## Custom Containers - -**Input** - -```md -::: info -This is an info box. -::: - -::: tip -This is a tip. -::: - -::: warning -This is a warning. -::: - -::: danger -This is a dangerous warning. -::: - -::: details -This is a details block. -::: -``` - -**Output** - -::: info -This is an info box. -::: - -::: tip -This is a tip. -::: - -::: warning -This is a warning. -::: - -::: danger -This is a dangerous warning. -::: - -::: details -This is a details block. -::: - -## More - -Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown). diff --git a/frontend/docs/src/zh/guide/features.md b/frontend/docs/src/zh/guide/features.md new file mode 100644 index 0000000..8825f14 --- /dev/null +++ b/frontend/docs/src/zh/guide/features.md @@ -0,0 +1,163 @@ +# 功能特性 + +探索 voidraft 的强大功能,让它成为开发者的优秀工具。 + +## 块状编辑 + +voidraft 的核心功能是其块状编辑系统: + +- 每个块可以有不同的编程语言 +- 块之间由分隔符分隔(`∞∞∞语言`) +- 快速在块之间导航 +- 独立格式化每个块 + +## 语法高亮 + +支持 30+ 种语言的专业语法高亮: + +- 自动语言检测 +- 可自定义配色方案 +- 支持嵌套语言 +- 代码折叠支持 + +## HTTP 客户端 + +用于 API 测试的内置 HTTP 客户端: + +### 请求类型 +- GET、POST、PUT、DELETE、PATCH +- 自定义请求头 +- 多种请求体格式:JSON、FormData、URL 编码、XML、文本 + +### 请求变量 +定义和重用变量: + +```http +@var { + baseUrl: "https://api.example.com", + token: "your-api-token" +} + +GET "{{baseUrl}}/users" { + authorization: "Bearer {{token}}" +} +``` + +### 响应处理 +- 查看格式化的 JSON 响应 +- 查看响应时间和大小 +- 检查响应头 +- 保存响应以供日后使用 + +## 代码格式化 + +集成 Prettier 支持: + +- 保存时格式化(可选) +- 格式化选区或整个块 +- 支持 JavaScript、TypeScript、CSS、HTML、JSON 等 +- 可自定义格式化规则 + +## 编辑器扩展 + +### VSCode 风格搜索 +- 查找和替换,支持正则表达式 +- 区分大小写和全字匹配选项 +- 跨所有块搜索 + +### 小地图 +- 文档的鸟瞰图 +- 快速导航 +- 可自定义大小和位置 + +### 彩虹括号 +- 彩色括号配对 +- 更容易匹配括号 +- 可自定义颜色 + +### 颜色选择器 +- 可视化颜色选择 +- 支持 hex、RGB、HSL +- 实时预览 + +### 翻译工具 +- 翻译选定的文本 +- 支持多种语言 +- 快速键盘访问 + +### 文本高亮 +- 高亮重要文本 +- 多种高亮颜色 +- 持久化高亮 + +## 多窗口支持 + +高效使用多个窗口: + +- 每个窗口都是独立的 +- 独立的文档 +- 同步的设置 +- 窗口状态持久化 + +## 主题自定义 + +完全控制编辑器外观: + +### 内置主题 +- 深色模式 +- 浅色模式 +- 根据系统自动切换 + +### 自定义主题 +- 创建你自己的主题 +- 自定义每种颜色 +- 保存和分享主题 +- 导入社区主题 + +## 自动更新系统 + +通过自动更新保持最新: + +- 后台更新检查 +- 新版本通知 +- 一键更新 +- 更新历史 +- 支持多个更新源(GitHub、Gitea) + +## 数据备份 + +使用基于 Git 的备份保护你的数据: + +- 自动备份 +- 手动触发备份 +- 支持 GitHub 和 Gitea +- 多种认证方式(SSH、Token、密码) +- 可配置备份间隔 + +## 键盘快捷键 + +广泛的键盘支持: + +- 可自定义快捷键 +- Vim/Emacs 按键绑定(计划中) +- 快速命令面板 +- 上下文感知快捷键 + +## 性能 + +专为速度而构建: + +- 快速启动时间 +- 流畅滚动 +- 高效内存使用 +- 支持大文件 + +## 隐私与安全 + +你的数据是安全的: + +- 本地优先存储 +- 可选云备份 +- 无遥测或跟踪 +- 开源代码库 + diff --git a/frontend/docs/src/zh/guide/getting-started.md b/frontend/docs/src/zh/guide/getting-started.md new file mode 100644 index 0000000..e147b9f --- /dev/null +++ b/frontend/docs/src/zh/guide/getting-started.md @@ -0,0 +1,110 @@ +# 快速开始 + +学习使用 voidraft 的基础知识并创建你的第一个文档。 + +## 编辑器界面 + +当你打开 voidraft 时,你将看到: + +- **主编辑器**:编写和编辑的中心区域 +- **工具栏**:快速访问常用操作 +- **状态栏**:显示当前块的语言和其他信息 + +## 创建代码块 + +voidraft 使用基于块的编辑系统。每个块可以有不同的语言: + +1. 按 `Ctrl+Enter` 创建新块 +2. 输入 `∞∞∞` 后跟语言名称(例如 `∞∞∞javascript`) +3. 在该块中开始编码 + +### 支持的语言 + +voidraft 支持 30+ 种编程语言,包括: +- JavaScript、TypeScript +- Python、Go、Rust +- HTML、CSS、Sass +- SQL、YAML、JSON +- 以及更多... + +## 基本操作 + +### 导航 + +- `Ctrl+Up/Down`:在块之间移动 +- `Ctrl+Home/End`:跳转到第一个/最后一个块 +- `Ctrl+F`:在文档中搜索 + +### 编辑 + +- `Ctrl+D`:复制当前行 +- `Ctrl+/`:切换注释 +- `Alt+Up/Down`:向上/向下移动行 +- `Ctrl+Shift+F`:格式化代码(如果语言支持 Prettier) + +### 块管理 + +- `Ctrl+Enter`:创建新块 +- `Ctrl+Shift+Enter`:在上方创建块 +- `Alt+Delete`:删除当前块 + +## 使用 HTTP 客户端 + +voidraft 包含用于测试 API 的内置 HTTP 客户端: + +1. 创建一个 HTTP 语言的块 +2. 编写你的 HTTP 请求: + +```http +POST "https://api.example.com/users" { + content-type: "application/json" + + @json { + name: "张三", + email: "zhangsan@example.com" + } +} +``` + +3. 点击运行按钮执行请求 +4. 内联查看响应 + +## 多窗口支持 + +同时处理多个文档: + +1. 转到 `文件 > 新建窗口`(或 `Ctrl+Shift+N`) +2. 每个窗口都是独立的 +3. 更改会自动保存 + +## 自定义主题 + +个性化你的编辑器: + +1. 打开设置(`Ctrl+,`) +2. 转到外观 +3. 选择主题或创建自己的主题 +4. 根据你的偏好自定义颜色 + +## 键盘快捷键 + +学习基本快捷键: + +| 操作 | 快捷键 | +|-----|--------| +| 新建窗口 | `Ctrl+Shift+N` | +| 搜索 | `Ctrl+F` | +| 替换 | `Ctrl+H` | +| 格式化代码 | `Ctrl+Shift+F` | +| 切换主题 | `Ctrl+Shift+T` | +| 命令面板 | `Ctrl+Shift+P` | + +## 下一步 + +现在你已经了解了基础知识: + +- 详细探索[功能特性](/zh/guide/features) +- 为你的数据设置 [Git 备份](/zh/guide/backup) +- 了解[扩展功能](/zh/guide/extensions) +- 配置[设置](/zh/guide/settings) + diff --git a/frontend/docs/src/zh/guide/installation.md b/frontend/docs/src/zh/guide/installation.md new file mode 100644 index 0000000..7e59893 --- /dev/null +++ b/frontend/docs/src/zh/guide/installation.md @@ -0,0 +1,63 @@ +# 安装 + +本指南将帮助你在系统上安装 voidraft。 + +## 系统要求 + +- **操作系统**:Windows 10 或更高版本(macOS 和 Linux 支持计划中) +- **内存**:最低 4GB,推荐 8GB +- **磁盘空间**:200MB 可用空间 + +## 下载 + +访问[发布页面](https://github.com/landaiqing/voidraft/releases)并下载适合你平台的最新版本: + +- **Windows**:`voidraft-windows-amd64-installer.exe` + +## 安装步骤 + +### Windows + +1. 从发布页面下载安装程序 +2. 运行 `voidraft-windows-amd64-installer.exe` 文件 +3. 按照安装向导操作 +4. 从开始菜单或桌面快捷方式启动 voidraft + +## 首次启动 + +首次启动 voidraft 时: + +1. 应用程序将创建一个数据目录来存储你的文档 +2. 你将看到带有欢迎块的主编辑器界面 +3. 开始输入或创建你的第一个代码块! + +## 配置 + +voidraft 将其配置和数据存储在: + +- **Windows**:`%APPDATA%/voidraft/` + +你可以自定义各种设置,包括: +- 编辑器主题(深色/浅色模式) +- 代码格式化偏好 +- 备份设置 +- 键盘快捷键 + +## 更新 + +voidraft 包含自动更新功能,会在有新版本时通知你。你可以: + +- 从设置中手动检查更新 +- 启用自动更新 +- 选择首选的更新源 + +## 故障排除 + +如果在安装过程中遇到任何问题: + +1. 确保你有管理员权限 +2. 检查杀毒软件是否阻止了安装 +3. 访问我们的 [GitHub issues](https://github.com/landaiqing/voidraft/issues) 页面寻求帮助 + +下一步:[快速开始 →](/zh/guide/getting-started) + diff --git a/frontend/docs/src/zh/guide/introduction.md b/frontend/docs/src/zh/guide/introduction.md new file mode 100644 index 0000000..79e81c1 --- /dev/null +++ b/frontend/docs/src/zh/guide/introduction.md @@ -0,0 +1,50 @@ +# 简介 + +欢迎使用 voidraft —— 一个专为开发者设计的优雅文本片段记录工具。 + +## 什么是 voidraft? + +voidraft 是一个现代化的桌面应用程序,帮助开发者管理文本片段、代码块、API 响应、会议笔记和日常待办事项。它为开发工作流程提供了流畅而优雅的编辑体验和强大的功能。 + +## 核心特性 + +### 块状编辑模式 + +voidraft 使用受 Heynote 启发的独特块状编辑系统。你可以将内容分割为独立的代码块,每个块具有: +- 不同的编程语言设置 +- 语法高亮 +- 独立格式化 +- 轻松在块之间导航 + +### 开发者工具 + +- **HTTP 客户端**:直接在编辑器中测试 API +- **代码格式化**:内置 Prettier 支持多种语言 +- **语法高亮**:支持 30+ 种编程语言 +- **自动语言检测**:自动识别代码块语言类型 + +### 自定义 + +- **自定义主题**:创建并保存你自己的编辑器主题 +- **扩展功能**:丰富的编辑器扩展,包括小地图、彩虹括号、颜色选择器等 +- **多窗口**:同时处理多个文档 + +### 数据管理 + +- **Git 备份**:使用 Git 仓库自动备份 +- **云同步**:跨设备同步你的数据 +- **自动更新**:及时获取最新功能 + +## 为什么选择 voidraft? + +- **专注开发者**:考虑开发者需求而构建 +- **现代技术栈**:使用前沿技术(Wails3、Vue 3、CodeMirror 6) +- **跨平台**:支持 Windows(macOS 和 Linux 支持计划中) +- **开源**:MIT 许可证,社区驱动开发 + +## 开始使用 + +准备好开始了吗?从我们的[发布页面](https://github.com/landaiqing/voidraft/releases)下载最新版本,或继续阅读文档了解更多。 + +下一步:[安装 →](/zh/guide/installation) + diff --git a/frontend/docs/src/zh/index.md b/frontend/docs/src/zh/index.md new file mode 100644 index 0000000..b34f209 --- /dev/null +++ b/frontend/docs/src/zh/index.md @@ -0,0 +1,56 @@ +--- +layout: home + +hero: + name: "voidraft" + text: "优雅的文本片段记录工具" + tagline: 为开发者设计,用现代技术打造 + image: + src: /static/img/hero.png + alt: "voidraft" + actions: + - theme: brand + text: 开始使用 + link: https://github.com/landaiqing/voidraft/releases + - theme: alt + text: 使用文档 + link: /zh/guide/introduction + +features: + - icon: 📝 + title: 块状编辑模式 + details: 将内容分割为独立的代码块,每个块可设置不同语言。继承了 Heynote 优雅的块状编辑理念。 + + - icon: 🎨 + title: 语法高亮 + details: 内置支持 30+ 种编程语言的语法高亮,自动语言检测,集成 Prettier 代码格式化工具。 + + - icon: 🌐 + title: HTTP 客户端 + details: 集成 HTTP 客户端,支持 JSON、FormData、XML 等多种请求格式。直接在编辑器中测试 API。 + + - icon: 🎯 + title: 多窗口支持 + details: 同时编辑多个文档,每个窗口独立维护自己的状态和配置。 + + - icon: 🎭 + title: 主题自定义 + details: 完整的主题自定义支持,支持深色/浅色模式。创建并保存你自己的编辑器主题。 + + - icon: 🔧 + title: 丰富的扩展 + details: VSCode 风格搜索替换、彩虹括号、小地图、颜色选择器、翻译工具、文本高亮等实用扩展。 + + - icon: 🔄 + title: 自动更新系统 + details: 内置自我更新机制,支持多个更新源。及时获取最新功能和改进。 + + - icon: ☁️ + title: Git 备份 + details: 基于 Git 的自动数据备份。支持 GitHub、Gitea,提供 SSH、Token 等多种认证方式。 + + - icon: ⚡ + title: 现代化架构 + details: 采用 Wails3、Vue 3 和 CodeMirror 6 构建。跨平台桌面应用,原生性能,现代化界面。 + +--- \ No newline at end of file