Skip to content

Commit d6c869e

Browse files
authored
Docs/community packages (#1714)
* typo * Adds feature list to the sveltekit plugin page * Removed Migrations section in side menu * Tidy up the table links * Creates a community packages section * Small tweak * Adds info and links to community packages * Updated mintlify broken links version in workflow file * fixed broken link
1 parent 31a4327 commit d6c869e

File tree

9 files changed

+80
-33
lines changed

9 files changed

+80
-33
lines changed

.github/workflows/docs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ jobs:
3939
${{ runner.os }}-mintlify
4040
4141
- name: 🔗 Check for broken links
42-
run: npx [email protected].222 broken-links
42+
run: npx [email protected].393 broken-links

docs/docs.json

+9-3
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,7 @@
201201
"dropdown": "Guides & examples",
202202
"description": "A great way to get started",
203203
"icon": "book",
204+
204205
"groups": [
205206
{
206207
"group": "Introduction",
@@ -213,7 +214,7 @@
213214
"guides/frameworks/nextjs",
214215
"guides/frameworks/nodejs",
215216
"guides/frameworks/remix",
216-
"guides/frameworks/sveltekit"
217+
"guides/community/sveltekit"
217218
]
218219
},
219220
{
@@ -298,8 +299,13 @@
298299
]
299300
},
300301
{
301-
"group": "Migrations",
302-
"pages": ["guides/use-cases/upgrading-from-v2"]
302+
"group": "Community packages",
303+
"pages": [
304+
"guides/community/dotenvx",
305+
"guides/community/fatima",
306+
"guides/community/rate-limiter",
307+
"guides/community/sveltekit"
308+
]
303309
}
304310
]
305311
}

docs/guides/community/dotenvx.mdx

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "dotenvx"
3+
sidebarTitle: "dotenvx"
4+
description: "A dotenvx package for Trigger.dev."
5+
icon: "square-e"
6+
---
7+
8+
This is a community developed package from [dotenvx](https://dotenvx.com/) that enables you to use dotenvx with Trigger.dev.
9+
10+
[View the docs](https://dotenvx.com/docs/background-jobs/triggerdotdev)

docs/guides/community/fatima.mdx

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: "Fatima"
3+
sidebarTitle: "Fatima"
4+
description: "A Fatima package for Trigger.dev."
5+
icon: "f"
6+
---
7+
8+
This is a community developed package from [@Fgc17](https://github.com/Fgc17) that enables you to use Fatima with Trigger.dev.
9+
10+
[View the Fatima docs](https://fatimajs.vercel.app/docs/adapters/trigger)
11+
12+
[View the repo](https://github.com/Fgc17/fatima)
+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Rate limiter"
3+
sidebarTitle: "Rate limiter"
4+
description: "A rate limiter for Trigger.dev."
5+
icon: "gauge-simple-low"
6+
---
7+
8+
This is a community developed package from [@ian](https://github.com/ian) that uses Redis to rate limit Trigger.dev tasks.
9+
10+
[View the repo](https://github.com/ian/trigger-rate-limiting)

docs/guides/community/sveltekit.mdx

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: "SvelteKit setup guide"
3+
sidebarTitle: "SvelteKit"
4+
description: "A plugin for SvelteKit to integrate with Trigger.dev."
5+
icon: "s"
6+
---
7+
8+
import Prerequisites from "/snippets/framework-prerequisites.mdx";
9+
10+
This is a community developed Vite plugin from [@cptCrunch_](https://x.com/cptCrunch_) that enables seamless integration between SvelteKit and Trigger.dev by allowing you to use your SvelteKit functions directly in your Trigger.dev projects.
11+
12+
## Features
13+
14+
- Use SvelteKit functions directly in Trigger.dev tasks
15+
- Automatic function discovery and export
16+
- TypeScript support with type preservation
17+
- Preserves JSDoc documentation
18+
- Hot Module Reloading support
19+
- Configurable directory scanning
20+
21+
<Prerequisites framework="SvelteKit" />
22+
23+
## Setup
24+
25+
[View setup guide on npm](https://www.npmjs.com/package/vite-plugin-triggerkit)
26+
27+
```bash
28+
npm i vite-plugin-triggerkit
29+
```
30+
31+
<UsefulNextSteps />

docs/guides/frameworks/sveltekit.mdx

-22
This file was deleted.

docs/guides/introduction.mdx

+6-6
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ mode: "center"
1212
<Card title="Next.js" img="/images/logo-nextjs.png" href="/guides/frameworks/nextjs"/>
1313
<Card title="Node.js" img="/images/logo-nodejs.png" href="/guides/frameworks/nodejs"/>
1414
<Card title="Remix" img="/images/logo-remix.png" href="/guides/frameworks/remix"/>
15-
<Card title="SvelteKit" img="/images/logo-svelte.png" href="/guides/frameworks/sveltekit"/>
15+
<Card title="SvelteKit" img="/images/logo-svelte.png" href="/guides/community/sveltekit"/>
1616
</CardGroup>
1717

1818

@@ -39,12 +39,12 @@ Get set up fast using our detailed walk-through guides.
3939

4040
Example projects are full projects with example repos you can fork and use. These are a great way of learning how to encorporate Trigger.dev into your project.
4141

42-
| Example project | Description | Framework | GitHub Repo |
42+
| Example project | Description | Framework | GitHub |
4343
| :-------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | :-------- | :---------------------------------------------------------------------------------------------------- |
44-
| [Realtime Fal.ai image generation](/guides/example-projects/realtime-fal-ai) | Generate an image from a prompt using Fal.ai and show the progress of the task on the frontend using Realtime. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/realtime-fal-ai-image-generation) |
45-
| [Batch LLM Evaluator](/guides/example-projects/batch-llm-evaluator) | Evaluate multiple LLM models and stream the results to the frontend. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/batch-llm-evaluator) |
46-
| [Realtime CSV Importer](/guides/example-projects/realtime-csv-importer) | Upload a CSV file and see the progress of the task streamed to the frontend. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/realtime-csv-importer) |
47-
| [Vercel AI SDK image generator](/guides/example-projects/vercel-ai-sdk-image-generator) | Use the Vercel AI SDK to generate images from a prompt. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/vercel-ai-sdk-image-generator) |
44+
| [Realtime Fal.ai image generation](/guides/example-projects/realtime-fal-ai) | Generate an image from a prompt using Fal.ai and show the progress of the task on the frontend using Realtime. | Next.js | [View repo](https://github.com/triggerdotdev/examples/tree/main/realtime-fal-ai-image-generation) |
45+
| [Batch LLM Evaluator](/guides/example-projects/batch-llm-evaluator) | Evaluate multiple LLM models and stream the results to the frontend. | Next.js | [View repo](https://github.com/triggerdotdev/examples/tree/main/batch-llm-evaluator) |
46+
| [Realtime CSV Importer](/guides/example-projects/realtime-csv-importer) | Upload a CSV file and see the progress of the task streamed to the frontend. | Next.js | [View repo](https://github.com/triggerdotdev/examples/tree/main/realtime-csv-importer) |
47+
| [Vercel AI SDK image generator](/guides/example-projects/vercel-ai-sdk-image-generator) | Use the Vercel AI SDK to generate images from a prompt. | Next.js | [View repo](https://github.com/triggerdotdev/examples/tree/main/vercel-ai-sdk-image-generator) |
4848

4949
## Example tasks
5050

docs/introduction.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ mode: "center"
2424

2525
Trigger.dev is an open source background jobs framework that lets you write reliable workflows in plain async code. Run long-running AI tasks, handle complex background jobs, and build AI agents with built-in queuing, automatic retries, and real-time monitoring. No timeouts, elastic scaling, and zero infrastructure management required.
2626

27-
We provide everything you need to build and manage background tasks: a [CLI and SDK](/config/config-file) for writing tasks in your existing codebase, support for both [regular](/tasks-regular) and [scheduled](/tasks/scheduled) tasks, full observability through our dashboard, and a [Realtime API](/realtime) with [React hooks](/frontend/react-hooks#realtime-hooks) for showing task status in your frontend. You can use [Trigger.dev Cloud](https://cloud.trigger.dev) or [self-host](/open-source-self-hosting) on your own infrastructure.
27+
We provide everything you need to build and manage background tasks: a [CLI and SDK](/config/config-file) for writing tasks in your existing codebase, support for both [regular](/tasks/overview) and [scheduled](/tasks/scheduled) tasks, full observability through our dashboard, and a [Realtime API](/realtime) with [React hooks](/frontend/react-hooks#realtime-hooks) for showing task status in your frontend. You can use [Trigger.dev Cloud](https://cloud.trigger.dev) or [self-host](/open-source-self-hosting) on your own infrastructure.
2828

2929
## Learn the concepts
3030

0 commit comments

Comments
 (0)