Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
hemengke1997 committed Nov 5, 2024
1 parent 02af4c8 commit df72aa5
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 3 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/deploy.yml → .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ jobs:
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # Not needed if lastUpdated is not enabled
- uses: pnpm/action-setup@v3
- name: Setup Node
uses: actions/setup-node@v4
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ on:

jobs:
test:
if: "contains(github.event.head_commit.message, 'release')"

timeout-minutes: 10
runs-on: ubuntu-latest

Expand Down
1 change: 0 additions & 1 deletion docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import { defineConfig } from 'vitepress'
export default defineConfig({
title: 'vite-plugin-remix-flat-routes',
description: 'Remix-flat-routes style file-system routing for React',
lastUpdated: true,
locales: {
root: {
label: 'English',
Expand Down
5 changes: 5 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,18 @@ hero:

features:
- title: Remix-style file-system routing
icon: 📦
details: Remix-flat-routes convention out of the box
- title: Data API Support
icon: 💪
details: React Router `action`, `loader`, `handle`, `errorElement`, `Component` etc.
- title: Extensible
icon: 🧩
details: Support custom route convention
- title: Flexible
icon: 🎨
details: Support legacy routing (react-router-dom<=6.3.0)
- title: Configurable
icon: ⚙️
details: Support configurable routing
---
5 changes: 5 additions & 0 deletions docs/zh/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,18 @@ hero:

features:
- title: Remix风格的文件系统路由
icon: 📦
details: 开箱即用的Remix-flat-routes约定式路由
- title: Data API
icon: 💪
details: React Router `action`、`loader`、`handle`、`errorElement`、`Component` 等
- title: 扩展
icon: 🧩
details: 支持自定义路由约定
- title: 灵活
icon: 🎨
details: 支持传统路由 (react-router-dom<=6.3.0)
- title: 配置化
icon: ⚙️
details: 支持配置式路由
---

0 comments on commit df72aa5

Please sign in to comment.