Skip to content

Documentation enhancement: Add verified guides and tutorials #2883

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 8 commits into
base: master
Choose a base branch
from
Draft

Documentation enhancement: Add verified guides and tutorials #2883

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8081aa2
Initial plan
Copilot Sep 29, 2025
5458a76
Add comprehensive documentation for Tips section and new feature guides
Copilot Sep 29, 2025
e107e27
Add comprehensive integrations, testing strategies, accessibility, an…
Copilot Sep 29, 2025
dda6d6b
Complete documentation enhancement with plugin development tutorial a…
Copilot Sep 29, 2025
5e5acb9
Fix keyboard shortcuts and feature documentation to match actual Alta…
Copilot Sep 30, 2025
6a8f9e5
Remove documentation files with extensive hallucinated APIs and fix r…
Copilot Sep 30, 2025
7d77cbc
Remove all remaining hallucinated content from documentation
Copilot Sep 30, 2025
e058848
Remove hallucinated content and fix documentation to match actual Alt…
Copilot Sep 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 95 additions & 2 deletions packages/altair-docs/docs/integrations/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,103 @@
---
title: Introduction
title: Integrations
has_children: true
permalink: /docs/integrations
order: 3
---

# Integrations

There are a number of packages that have been created to help you integrate Altair within your existing application or workflow.
There are a number of packages and integration methods that have been created to help you integrate Altair within your existing application or workflow.

## Server-Side Integrations

### Node.js Middleware

Integrate Altair directly into your Node.js GraphQL servers:

#### [Express Middleware](/docs/integrations/altair-express-middleware)
<Badge text="npm" type="danger"/>

Add Altair to your Express.js applications with minimal setup.

#### [Koa Middleware](/docs/integrations/altair-koa-middleware)
<Badge text="npm" type="danger"/>

Integrate Altair with Koa.js applications for GraphQL development.

#### [Static Rendering](/docs/integrations/altair-static)
<Badge text="npm" type="danger"/>

Render Altair as static HTML for any Node.js application or custom integration.

## Framework Integrations

### Modern Web Frameworks

#### [Next.js Integration](/docs/integrations/nextjs-integration)
Complete guide for integrating Altair into Next.js applications, including App Router and Pages Router support.

### Static Site Generators

#### [Gatsby Plugin](/docs/integrations/gatsby-plugin-altair-graphql)
<Badge text="npm" type="danger"/>

Official Gatsby plugin for adding Altair to your Gatsby sites during development.

## Custom Integrations

Using the packages above, you can create custom integrations for any platform or framework. Check out the individual integration guides for examples.

## CDN Usage

For quick integration without npm packages, you can use Altair directly from a CDN:

```html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>Altair</title>
<base href="https://unpkg.com/altair-static@latest/build/dist/" />

<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="icon" type="image/x-icon" href="favicon.ico" />
<link rel="stylesheet" href="styles.css" />
</head>

<body>
<script>
document.addEventListener("DOMContentLoaded", () => {
AltairGraphQL.init();
});
</script>
<app-root>
<style>
.loading-screen {
/*Prevents the loading screen from showing until CSS is downloaded*/
display: none;
}
</style>
<div class="loading-screen styled">
<div class="loading-screen-inner">
<div class="loading-screen-logo-container">
<img src="assets/img/logo_350.svg" alt="Altair" />
</div>
<div class="loading-screen-loading-indicator">
<span class="loading-indicator-dot"></span>
<span class="loading-indicator-dot"></span>
<span class="loading-indicator-dot"></span>
</div>
</div>
</div>
</app-root>
<script type="text/javascript" src="runtime.js"></script>
<script type="text/javascript" src="polyfills.js"></script>
<script type="text/javascript" src="main.js"></script>
</body>
</html>
```

## Need Help?

Check out our [GitHub repository](https://github.com/altair-graphql/altair) for the latest integration examples and community contributions.
Loading