Skip to content

Commit

Permalink
docs: add Jacob to Fastify plugin collaborators
Browse files Browse the repository at this point in the history
  • Loading branch information
mrlubos committed Feb 13, 2025
1 parent f017284 commit d750586
Show file tree
Hide file tree
Showing 29 changed files with 151 additions and 9 deletions.
21 changes: 21 additions & 0 deletions docs/.vitepress/theme/components/AuthorsList.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<script setup lang="ts">
type Person = {
github: string;
name: string;
};
defineProps<{
people: Person[];
}>();
</script>

<template>
<ul class="authors-list">
<li v-for="person in people" :key="person.github">
<a :href="person.github" rel="noopener noreferrer" target="_blank">
<img :alt="person.name" :src="`${person.github}.png`" />
<h3>{{ person.name }}</h3>
</a>
</li>
</ul>
</template>
49 changes: 49 additions & 0 deletions docs/.vitepress/theme/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,51 @@ iframe {
margin: 0;
}

.authors-list {
display: flex;
flex-wrap: wrap;
font-size: 1rem;
gap: 1em;
padding: 0 !important;
}

.authors-list img {
border-radius: 50%;
display: block;
height: 2rem;
width: 2rem;
}

.authors-list a {
align-items: center;
border: 1px solid transparent;
border-radius: 10px;
display: flex;
column-gap: 0.4em;
padding: 0.4em 0.6em;
text-decoration: none;
transition: border-color ease-out 300ms;
}

.authors-list h3 {
color: var(--vp-c-text-1);
font-size: inherit;
margin: 0;
}

.authors-list a::after {
display: none !important;
}

.authors-list li {
margin: 0 !important;
}

h3#demo + iframe,
h3#demo + button {
margin: 1rem 0 0;
}

.buttonLink {
color: var(--vp-c-brand-1);
font-size: 16px;
Expand All @@ -67,6 +112,7 @@ iframe {
text-align: center;
}

.authors-list li,
.home-list li,
.sponsors-list li {
list-style: none;
Expand Down Expand Up @@ -129,6 +175,7 @@ iframe {
width: 100%;
}

html.dark .authors-list li > a,
html.dark .sponsors-list li > a {
background-color: var(--vp-button-brand-bg);
}
Expand All @@ -138,6 +185,8 @@ html.dark .sponsors-list li > a {
display: none;
}

.authors-list li > a:hover,
.authors-list li > a:focus,
.sponsors-list li > a:hover,
.sponsors-list li > a:focus {
border-color: var(--vp-c-brand-1);
Expand Down
4 changes: 4 additions & 0 deletions docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@ import DefaultTheme from 'vitepress/theme';
// custom CSS must be imported after default theme to correctly apply styles
import './custom.css';

import AuthorsList from './components/AuthorsList.vue';
import Layout from './Layout.vue';

export default {
Layout,
enhanceApp: ({ app }) => {
app.component('AuthorsList', AuthorsList);
},
extends: DefaultTheme,
} satisfies Theme;
6 changes: 5 additions & 1 deletion docs/openapi-ts/clients/axios.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,14 @@ import { embedProject } from '../../embed'
Axios client is currently in beta. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
:::

### About

[Axios](https://axios-http.com/) is a simple promise based HTTP client for the browser and Node.js. Axios provides a simple to use library in a small package with a very extensible interface.

### Demo

<button class="buttonLink" @click="(event) => embedProject('hey-api-client-axios-example')(event)">
Live demo
Launch demo
</button>

## Installation
Expand Down
6 changes: 5 additions & 1 deletion docs/openapi-ts/clients/fetch.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,14 @@ import { embedProject } from '../../embed'
Fetch API client is currently in beta. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
:::

### About

The [Fetch API](https://developer.mozilla.org/docs/Web/API/Fetch_API) provides an interface for fetching resources (including across the network). It is a more powerful and flexible replacement for XMLHttpRequest.

### Demo

<button class="buttonLink" @click="(event) => embedProject('hey-api-client-fetch-example')(event)">
Live demo
Launch demo
</button>

## Installation
Expand Down
4 changes: 3 additions & 1 deletion docs/openapi-ts/clients/next-js.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@ description: Next.js client for Hey API. Compatible with all our features.
Next.js client is currently in beta. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
:::

### About

[Next.js](https://nextjs.org/) is the React framework for the web. Used by some of the world's largest companies, Next.js enables you to create high-quality web applications with the power of React components.

<!-- <button class="buttonLink" @click="(event) => embedProject('hey-api-client-next-example')(event)">
Live demo
Launch demo
</button> -->

## Installation
Expand Down
4 changes: 3 additions & 1 deletion docs/openapi-ts/clients/nuxt.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@ description: Nuxt client for Hey API. Compatible with all our features.
Nuxt client is currently in beta. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
:::

### About

[Nuxt](https://nuxt.com/) is an open source framework that makes web development intuitive and powerful.

<!-- <button class="buttonLink" @click="(event) => embedProject('hey-api-client-fetch-example')(event)">
Live demo
Launch demo
</button> -->

## Installation
Expand Down
4 changes: 3 additions & 1 deletion docs/openapi-ts/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,10 @@ This package is in initial development. The interface might change before it bec

[@hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) is an OpenAPI to TypeScript codegen trusted more than 800k times each month to generate reliable API clients and SDKs. The code is [MIT-licensed](/license) and free to use. Discover available features below or view our [roadmap](https://github.com/orgs/hey-api/discussions/1495) to learn what's coming next.

### Demo

<button class="buttonLink" @click="(event) => embedProject('hey-api-example')(event)">
Live demo
Launch demo
</button>

## Features
Expand Down
2 changes: 2 additions & 0 deletions docs/openapi-ts/plugins/ajv.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: Ajv plugin for Hey API. Compatible with all our features.
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1476).
:::

### About

[Ajv](https://ajv.js.org/) is the fastest JSON validator for Node.js and browser.

<!--@include: ../../sponsors.md-->
2 changes: 2 additions & 0 deletions docs/openapi-ts/plugins/arktype.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: Arktype plugin for Hey API. Compatible with all our features.
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1473).
:::

### About

[Arktype](https://arktype.io/) is a TypeScript's 1:1 validator, optimized from editor to runtime.

<!--@include: ../../sponsors.md-->
2 changes: 2 additions & 0 deletions docs/openapi-ts/plugins/express.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: Express plugin for Hey API. Compatible with all our features.
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1484).
:::

### About

[Express](https://expressjs.com/) is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications.

<!--@include: ../../sponsors.md-->
2 changes: 2 additions & 0 deletions docs/openapi-ts/plugins/faker.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: Faker plugin for Hey API. Compatible with all our features.
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1485).
:::

### About

[Faker](https://fakerjs.dev/) is a popular library that generates fake (but reasonable) data that can be used for things such as unit testing, performance testing, building demos, and working without a completed backend.

<!--@include: ../../sponsors.md-->
14 changes: 12 additions & 2 deletions docs/openapi-ts/plugins/fastify.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,21 @@ description: Fastify plugin for Hey API. Compatible with all our features.
Fastify plugin is currently in beta. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
:::

### About

[Fastify](https://fastify.dev/) is a fast and low overhead web framework for Node.js.

<!-- ### Demo
<button class="buttonLink" @click="(event) => embedProject('hey-api-client-fetch-plugin-fastify-example')(event)">
Live demo
</button>
StackBlitz
</button> -->

### Collaborators

<AuthorsList :people="[
{ name: 'Jacob Cohen', github: 'https://github.com/jacobinu' },
]" />

## Features

Expand Down
2 changes: 2 additions & 0 deletions docs/openapi-ts/plugins/hono.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: Hono plugin for Hey API. Compatible with all our features.
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1483).
:::

### About

[Hono](https://hono.dev/) is a small, simple, and ultrafast web framework built on Web Standards. It works on any JavaScript runtime: Cloudflare Workers, Fastly Compute, Deno, Bun, Vercel, Netlify, AWS Lambda, Lambda@Edge, and Node.js.

<!--@include: ../../sponsors.md-->
2 changes: 2 additions & 0 deletions docs/openapi-ts/plugins/joi.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: Joi plugin for Hey API. Compatible with all our features.
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1477).
:::

### About

[Joi](https://joi.dev/) is the most powerful schema description language and data validator for JavaScript.

<!--@include: ../../sponsors.md-->
2 changes: 2 additions & 0 deletions docs/openapi-ts/plugins/koa.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: Koa plugin for Hey API. Compatible with all our features.
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1482).
:::

### About

[Koa](https://koajs.com/) is a new web framework designed by the team behind Express, which aims to be a smaller, more expressive, and more robust foundation for web applications and APIs.

<!--@include: ../../sponsors.md-->
2 changes: 2 additions & 0 deletions docs/openapi-ts/plugins/msw.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: MSW plugin for Hey API. Compatible with all our features.
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1486).
:::

### About

[MSW](https://mswjs.io/) is an API mocking library that allows you to write client-agnostic mocks and reuse them across any frameworks, tools, and environments.

<!--@include: ../../sponsors.md-->
2 changes: 2 additions & 0 deletions docs/openapi-ts/plugins/nest.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: Nest plugin for Hey API. Compatible with all our features.
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1481).
:::

### About

[Nest](https://nestjs.com/) is a progressive Node.js framework for building efficient, reliable and scalable server-side applications.

<!--@include: ../../sponsors.md-->
2 changes: 2 additions & 0 deletions docs/openapi-ts/plugins/nock.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: Nock plugin for Hey API. Compatible with all our features.
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1487).
:::

### About

[Nock](https://github.com/nock/nock) is an HTTP server mocking and expectations library for Node.js.

<!--@include: ../../sponsors.md-->
2 changes: 2 additions & 0 deletions docs/openapi-ts/plugins/pinia-colada.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: Pinia Colada plugin for Hey API. Compatible with all our features.
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1242).
:::

### About

[Pinia Colada](https://pinia-colada.esm.dev/) is the data fetching layer for Pinia.

<!--@include: ../../sponsors.md-->
2 changes: 2 additions & 0 deletions docs/openapi-ts/plugins/superstruct.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: Superstruct plugin for Hey API. Compatible with all our features.
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1489).
:::

### About

[Superstruct](https://docs.superstructjs.org/) makes it easy to define interfaces and then validate JavaScript data against them.

<!--@include: ../../sponsors.md-->
2 changes: 2 additions & 0 deletions docs/openapi-ts/plugins/supertest.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: Supertest plugin for Hey API. Compatible with all our features.
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1488).
:::

### About

[Supertest](https://github.com/ladjs/supertest) is a super-agent driven library for testing node.js HTTP servers using a fluent API.

<!--@include: ../../sponsors.md-->
2 changes: 2 additions & 0 deletions docs/openapi-ts/plugins/swr.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: SWR plugin for Hey API. Compatible with all our features.
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1479).
:::

### About

[SWR](https://swr.vercel.app/) is a strategy to first return the data from cache (stale), then send the fetch request (revalidate), and finally come with the up-to-date data.

<!--@include: ../../sponsors.md-->
6 changes: 5 additions & 1 deletion docs/openapi-ts/plugins/tanstack-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,14 @@ import { embedProject } from '../../embed'
TanStack Query plugin is currently in beta. The interface might change before it becomes stable. We encourage you to leave feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues).
:::

### About

[TanStack Query](https://tanstack.com/query) is a powerful asynchronous state management solution for TypeScript/JavaScript, React, Solid, Vue, Svelte, and Angular.

### Demo

<button class="buttonLink" @click="(event) => embedProject('hey-api-client-fetch-plugin-tanstack-react-query-example')(event)">
Live demo
Launch demo
</button>

## Features
Expand Down
2 changes: 2 additions & 0 deletions docs/openapi-ts/plugins/typebox.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: TypeBox plugin for Hey API. Compatible with all our features.
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1475).
:::

### About

[TypeBox](https://github.com/sinclairzx81/typebox) is a JSON Schema type builder with static type resolution for TypeScript.

<!--@include: ../../sponsors.md-->
2 changes: 2 additions & 0 deletions docs/openapi-ts/plugins/valibot.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: Valibot plugin for Hey API. Compatible with all our features.
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1474).
:::

### About

[Valibot](https://valibot.dev/) is the open source schema library for TypeScript with bundle size, type safety and developer experience in mind.

<!--@include: ../../sponsors.md-->
2 changes: 2 additions & 0 deletions docs/openapi-ts/plugins/yup.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ description: Yup plugin for Hey API. Compatible with all our features.
This feature isn't in development yet. Help us prioritize it by voting on [GitHub](https://github.com/hey-api/openapi-ts/issues/1478).
:::

### About

[Yup](https://github.com/jquense/yup) is a schema builder for runtime value parsing and validation.

<!--@include: ../../sponsors.md-->
6 changes: 5 additions & 1 deletion docs/openapi-ts/plugins/zod.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,14 @@ description: Zod plugin for Hey API. Compatible with all our features.
This feature is in development! :tada: Try it out and provide feedback on [GitHub](https://github.com/hey-api/openapi-ts/issues/876).
:::

### About

[Zod](https://zod.dev/) is a TypeScript-first schema validation library with static type inference.

### Demo

<button class="buttonLink" @click="(event) => embedProject('hey-api-client-fetch-plugin-zod-example')(event)">
Live demo
Launch demo
</button>

## Features
Expand Down
Loading

0 comments on commit d750586

Please sign in to comment.