# Introduction
URL: /docs

Real-time Vercel deployment notifications for Discord

***

title: Introduction
description: Real-time Vercel deployment notifications for Discord
icon: House
-----------

# Vercel to Discord

A lightweight integration service that connects Vercel deployments with Discord,
delivering real-time status notifications to your team channels. Enhance your
DevOps workflow with immediate visibility into your deployment pipeline.

# Features

* Real-time deployment event notifications
* Support for all Vercel webhook event types
* Rich Discord embeds with status-specific colors and icons
* Direct links to Vercel deployments, projects, and GitHub commits
* Context-rich information including branch, commit, and environment details
* Reliable delivery with retry mechanism for handling rate limits
* Easily extensible for customization


# Environment
URL: /docs/installation/environment

How to setup environment variables for Vercord

***

title: Environment
description: How to setup environment variables for Vercord
icon: Settings
--------------

import { TypeTable } from 'fumadocs-ui/components/type-table';

# Environment Variables

These are the environment variables you need to set at your Vercord instance in
Vercel for it to work

<TypeTable
  type={{
  WEBHOOK_INTEGRATION_SECRET: {
    description: 'The secret for the Vercel webhook integration',
    type: 'string',
    default: 'your-secret',
    required: true
  },
  DISCORD_WEBHOOK_URL: {
    description: 'The URL for the Discord webhook integration',
    type: 'string',
    default: 'https://discord.com/api/webhooks/<id>/<token>',
    required: true
  },
  DISCORD_WEBHOOK_USERNAME: {
    description: 'The username for the Discord webhook',
    type: 'string',
    default: 'Vercord',
    required: false
  },
  DISCORD_WEBHOOK_AVATAR_URL: {
    description: 'The avatar URL for the Discord webhook',
    type: 'string',
    default: 'https://vercord.dev/logo.jpg',
    required: false
  }
}}
/>

## Security Considerations

* Store your webhook secret securely with a unique value for each integration
* All incoming webhooks are validated using HMAC-SHA1 signatures
* Webhook payloads are validated against a strict schema to ensure data
  integrity

Then just redeploy your Vercord instance and you're done!


# Requirements
URL: /docs/installation/requirements

Requirements for Vercord installation

***

title: Requirements
description: Requirements for Vercord installation
icon: ListCheck
---------------

# Prerequisites

To set up Vercord, you will need the following:

1. A Vercel account with project(s).
2. A Discord server with the "Manage Webhooks" permission.
3. Your own Vercord instance:
   [Click here to deploy](https://vercel.com/new/clone?repository-url=https://github.com/vercord/vercord)


# Setup Discord
URL: /docs/installation/setup-discord

How to setup Discord for Vercord

***

title: Setup Discord
description: How to setup Discord for Vercord
icon: CheckCheck
----------------

import { Step, Steps } from 'fumadocs-ui/components/steps';

# Setup Discord

<Steps>
  <Step>
    ### Open Discord and Go to Your Server

    Open Discord and navigate to the server where you want to receive Vercord
    messages.
  </Step>

  <Step>
    ### Edit the Target Channel

    Right-click the channel you want to use and select **Edit Channel**.
  </Step>

  <Step>
    ### Go to Integrations > Webhooks

    In the channel settings, go to the **Integrations** tab, then click
    **Webhooks**.
  </Step>

  <Step>
    ### Create or Select a Webhook

    Click **New Webhook** (or select an existing one). Name it (e.g., `Vercord`).
  </Step>

  <Step>
    ### Copy the Webhook URL

    Copy the **Webhook URL** provided by Discord.

    <Callout>Save the webhook URL, you will need it for later.</Callout>
  </Step>
</Steps>


# Setup Vercel
URL: /docs/installation/setup-vercel

How to setup Vercel for Vercord

***

title: Setup Vercel
description: How to setup Vercel for Vercord
icon: Check
-----------

import { Step, Steps } from 'fumadocs-ui/components/steps';

# Setup Vercel

<Steps>
  <Step>
    ### Access Vercel Dashboard

    Sign in to your account and navigate to the
    [Vercel Dashboard](https://vercel.com/dashboard) to manage your projects.
  </Step>

  <Step>
    ### Navigate to Project Settings

    Click on the **Settings** tab in the navigation menu.
  </Step>

  <Step>
    ### Access Webhooks Section

    In the left sidebar of your project settings, locate and click on the
    **Webhooks** option.
  </Step>

  <Step>
    ### Configure New Webhook

    Click the **Create Webhook** button and configure your webhook with:

    * **URL**: `https://<your-deployed-url>/api/vercel-webhook`
    * Choose which events should trigger the webhook.
  </Step>

  <Step>
    ### Save Your Secret

    Click **Create Webhook** to save your webhook configuration.

    <Callout>
      Save the secret that Vercel provides you, you will need it for later.
    </Callout>
  </Step>
</Steps>


# llms-full.txt
URL: /docs/llms/llms-full.txt

Get all documentation content in a single text response

***

title: llms-full.txt
description: Get all documentation content in a single text response
icon: FileText
--------------

# LLMs Full Text

Access all documentation pages combined into one text response at
`/llms-full.txt`.

[Click here](https://vercord.lol/llms-full.txt) to go to the 'llms-full.txt'
page.

## Usage

```
GET /llms-full.txt
```

Returns all pages with this format:

```
# Page Title
URL: /page-url

Page description

Page content...

# Next Page Title
URL: /next-page-url

Next page description

Next page content...
```

## How it works

1. Fetches all documentation pages from the source
2. Processes each page through the `getLLMText` function
3. Combines them with double newline separators
4. Returns as plain text response

The response is cached forever (`revalidate = false`) for performance.


# .mdx
URL: /docs/llms/mdx

Get raw page content by adding .mdx to any documentation URL

***

title: '.mdx'
description: Get raw page content by adding .mdx to any documentation URL
icon: Code
----------

# MDX Endpoint

Append `.mdx` to any documentation page URL to get its raw content.

## Usage

```
/docs → /docs.mdx
/docs/installation/requirements → /docs/installation/requirements.mdx
```

## Response Format

```
# Page Title
URL: /page-url

Page description

Processed page content...
```

## How it works

1. Uses dynamic route `llms.mdx/[[...slug]]/route.ts`
2. Matches the slug to find the corresponding page
3. Processes content through `getLLMText` function
4. Returns formatted text response
5. Returns 404 if page doesn't exist

All routes are statically generated at build time for performance.


# Page Actions
URL: /docs/llms/page-actions

Copy content and open in AI tools from any documentation page

***

title: Page Actions
description: Copy content and open in AI tools from any documentation page
icon: MousePointer
------------------

# Page Actions

Two buttons on every documentation page: "Copy Markdown" and "Open" dropdown.

## Copy Markdown Button

Copies the page's raw content to clipboard.

1. Fetches content from `[page-url].mdx`
2. Caches the result for subsequent copies
3. Copies to clipboard using Clipboard API
4. Shows check icon when complete

## Open Dropdown

Opens the current page in external tools:

| Option              | Action                                     |
| ------------------- | ------------------------------------------ |
| **Open in GitHub**  | Links to source file in repository         |
| **Open in ChatGPT** | Opens ChatGPT with page content pre-loaded |
| **Open in Claude**  | Opens Claude with page content pre-loaded  |
| **Open in T3 Chat** | Opens T3 Chat with page content pre-loaded |

AI tools receive a prompt: "Read \[page-url].mdx, I want to ask questions about
it."