Skip to content

Commit

Permalink
docs: update intro page
Browse files Browse the repository at this point in the history
  • Loading branch information
johannschopplich committed Nov 11, 2024
1 parent 4a6af04 commit a74d973
Show file tree
Hide file tree
Showing 6 changed files with 753 additions and 752 deletions.
13 changes: 6 additions & 7 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
import { defineConfig } from 'vitepress'
import type { DefaultTheme } from 'vitepress'
import UnoCSS from 'unocss/vite'
import { description, version } from '../../package.json'
import {
github,
name,
ogImage,
ogUrl,
releases,
} from './meta'
import { github, name, ogImage, ogUrl, releases } from './meta'

const url = new URL(ogUrl)

Expand All @@ -34,6 +29,10 @@ export default defineConfig({

appearance: 'dark',

vite: {
plugins: [UnoCSS()],
},

themeConfig: {
logo: '/logo.svg',

Expand Down
22 changes: 21 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ hero:

features:
- title: Generated composables
icon: <span class="i-carbon:list-dropdown"></span>
icon: <span class="i-carbon:magic-wand-filled"></span>
details: Auto-generated composables for each API endpoint.
link: /api/
linkText: API Reference
Expand All @@ -40,4 +40,24 @@ features:
details: Configure all your APIs once and use them throughout your app.
link: /guide/getting-started.html#step-3-set-up-api-endpoints
linkText: Set up API Endpoints
- title: OpenAPI Support
icon: <span class="i-devicon-plain:openapi"></span>
details: Create fully typed API clients from OpenAPI specifications.
link: /guide/openapi-types
linkText: Generate Clients
- title: TypeScript
icon: <span class="i-devicon-plain:typescript"></span>
details: Type-safe parameters, request bodies and responses for OpenAPI endpoints.
link: /guide/openapi-types
linkText: Leaverage Typings
- title: Hooks
icon: <span class="i-carbon:tools-alt"></span>
details: Customize the module's behavior with hooks.
link: /guide/hooks
linkText: Customize at Build-Time
- title: Proxy Errors
icon: <span class="i-carbon:error-outline"></span>
details: Pass-through errors from your API to your app.
link: /guide/error-handling
linkText: Log and Handle Errors
---
3 changes: 2 additions & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
},
"devDependencies": {
"@iconify-json/carbon": "^1.2.4",
"unocss": "^0.63.6",
"@iconify-json/devicon-plain": "^1.2.4",
"unocss": "^0.64.0",
"vitepress": "^1.5.0"
}
}
18 changes: 0 additions & 18 deletions docs/vite.config.ts

This file was deleted.

8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"release": "bumpp"
},
"dependencies": {
"@nuxt/kit": "^3.14.0",
"@nuxt/kit": "^3.14.159",
"defu": "^6.1.4",
"jiti": "^2.4.0",
"ofetch": "^1.4.1",
Expand All @@ -64,11 +64,11 @@
"@nuxt/eslint-config": "^0.6.1",
"@nuxt/module-builder": "^0.8.4",
"@nuxt/test-utils": "^3.14.4",
"@types/node": "^22.8.7",
"@types/node": "^22.9.0",
"bumpp": "^9.8.1",
"eslint": "^9.14.0",
"nuxt": "^3.14.0",
"openapi-typescript": "^7.4.2",
"nuxt": "^3.14.159",
"openapi-typescript": "^7.4.3",
"typescript": "^5.6.3",
"vitest": "^2.1.4",
"vue-tsc": "^2.1.10"
Expand Down
Loading

0 comments on commit a74d973

Please sign in to comment.