Skip to content

Commit

Permalink
new docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nksaraf committed Feb 27, 2024
1 parent f2990ad commit d2beda7
Show file tree
Hide file tree
Showing 12 changed files with 12,006 additions and 6,509 deletions.
73 changes: 73 additions & 0 deletions docs/.config/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# yaml-language-server: $schema=https://unpkg.com/undocs/schema/config.json
name: vinxi
shortDescription: The Modern Full Stack Javascript SDK
description: The Modern Full Stack Javascript SDK
github: nksaraf/vinxi
themeColor: amber
url: https://vinxi.vercel.app
automd: true
redirects: {}
landing:
heroLinks:
playOnline:
label: "Play Online"
icon: "i-simple-icons-lightning"
to: "https://stackblitz.com/github/unjs/h3/tree/main/playground"
contributors: true
featuresTitle: "The Web Framework for Modern JavaScript Era"
features:
# Runtime Agnostic
- title: "Runtime Agnostic"
description: "Your code will work on any JavaScript runtime including Node.js, Bun, Deno and Workers."
icon: "i-material-symbols-lock-open-right-outline-rounded"
to: ""
target: "_blank"

# Tree-shakable
- title: "Small and Tree-shakable"
description: "h3 core is super lightweight and tree-shakable, only what you use will be included in the the final bundle."
icon: "i-material-symbols-potted-plant-outline"
to: ""
target: "_blank"

# Composable
- title: "Composable"
description: "Expand your server and add capabilities. Your codebase will scale with your project."
icon: "i-fa-puzzle-piece"
to: ""
target: "_blank"

# Router
- title: "Fast Router"
description: "Super fast route matching using unjs/radix3"
icon: "i-fa-tree"
to: "https://github.com/unjs/radix3"
target: "_blank"

# Ecosystem
- title: "UnJS ecosystem"
description: "Built on top of powerful UnJS ecosystem powering Nitro, Nuxt and more frameworks!"
icon: "i-mdi-umbrella-outline"
to: "https://unjs.io"
target: "_blank"

# Made for Humans
- title: "Made for Humans"
description: "Elegant minimal API to implement HTTP handlers compatible with Web-Standards."
icon: "i-material-symbols-robot-2-sharp"
to: ""
target: "_blank"

# Compatibility
- title: "Compatible"
description: "Compatibility layer with node/connect/express middleware."
icon: "i-simple-icons-express"
to: ""
target: "_blank"

# Type Friendly
- title: "Type Friendly"
description: "Codebase fully written in TypeScript with strongly typed utils."
icon: "i-mdi-language-typescript"
to: ""
target: "_blank"
3 changes: 3 additions & 0 deletions docs/.config/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* {
background-color: red;
}
File renamed without changes.
File renamed without changes
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.docs/.nuxt
12 changes: 0 additions & 12 deletions docs/.vitepress/components/Signature.vue

This file was deleted.

100 changes: 0 additions & 100 deletions docs/.vitepress/config.mts

This file was deleted.

21 changes: 0 additions & 21 deletions docs/.vitepress/theme/index.ts

This file was deleted.

148 changes: 0 additions & 148 deletions docs/.vitepress/theme/style.css

This file was deleted.

Binary file added docs/bun.lockb
Binary file not shown.
21 changes: 5 additions & 16 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -1,22 +1,11 @@
{
"name": "docs",
"version": "1.0.0",
"description": "",
"main": "index.js",
"private": true,
"type": "module",
"scripts": {
"dev": "vitepress dev .",
"build": "vitepress build ."
},
"keywords": [],
"author": "",
"license": "ISC",
"dependencies": {
"@shikijs/vitepress-twoslash": "^1.1.2",
"vinxi": "workspace:^",
"vitepress": "1.0.0-rc.42",
"vue": "^3.4.19"
"build": "undocs build",
"dev": "undocs dev"
},
"devDependencies": {
"zod": "^3.22.2"
"undocs": "^0.2.16"
}
}
Loading

0 comments on commit d2beda7

Please sign in to comment.