mirror of
https://github.com/BerriAI/litellm.git
synced 2026-10-08 03:08:45 +00:00
feat: Add adopters page and data structure
Co-authored-by: krrishdholakia <krrishdholakia@gmail.com>
This commit is contained in:
parent
0aae5153b6
commit
07b5924895
4 changed files with 127 additions and 0 deletions
88
docs/my-website/src/data/adopters/README.md
Normal file
88
docs/my-website/src/data/adopters/README.md
Normal file
|
|
@ -0,0 +1,88 @@
|
|||
# LiteLLM Adopters
|
||||
|
||||
This directory contains data for organizations that use LiteLLM in production.
|
||||
|
||||
## Adding Your Organization
|
||||
|
||||
We've made it super easy to add your organization! Just follow the steps below.
|
||||
|
||||
### Quick Add (Recommended)
|
||||
|
||||
**[Edit adopters.json on GitHub →](https://github.com/BerriAI/litellm/edit/main/docs/my-website/src/data/adopters/adopters.json)**
|
||||
|
||||
This will open the GitHub editor in your browser where you can:
|
||||
|
||||
1. Add your organization's entry to the JSON array
|
||||
2. Commit your changes
|
||||
3. GitHub will automatically create a pull request for you!
|
||||
|
||||
No need to clone the repository or set up a development environment.
|
||||
|
||||
### JSON Format
|
||||
|
||||
Add your organization to the array in `adopters.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Your Organization Name",
|
||||
"logoUrl": "https://yoursite.com/logo.svg",
|
||||
"url": "https://yourcompany.com",
|
||||
"description": "Brief description of how you use LiteLLM (shown on hover)"
|
||||
}
|
||||
```
|
||||
|
||||
### Fields
|
||||
|
||||
- **`name`** (required): Your organization's display name
|
||||
- **`logoUrl`** (required): URL to your logo - can be either:
|
||||
- External URL: `https://yoursite.com/logo.svg` (easiest!)
|
||||
- Local path: `/img/adopters/your-logo.svg` (requires uploading logo file)
|
||||
- **`url`** (optional): Your organization's website (makes the logo clickable)
|
||||
- **`description`** (optional): Brief description shown when users hover over your logo
|
||||
|
||||
### Logo Options
|
||||
|
||||
#### Option 1: External URL (Easiest)
|
||||
|
||||
Simply provide a direct link to your logo hosted anywhere:
|
||||
|
||||
```json
|
||||
"logoUrl": "https://yourcompany.com/assets/logo.svg"
|
||||
```
|
||||
|
||||
#### Option 2: Local Logo (Better Performance)
|
||||
|
||||
If you prefer to host the logo locally:
|
||||
|
||||
1. Add your logo to `docs/my-website/static/img/adopters/your-company.svg`
|
||||
2. Reference it as: `"logoUrl": "/img/adopters/your-company.svg"`
|
||||
|
||||
**Logo Specifications:**
|
||||
|
||||
- **Format**: SVG preferred (PNG also acceptable)
|
||||
- **Dimensions**: 240x160px or similar 3:2 ratio recommended
|
||||
- **Background**: Transparent or white background works best
|
||||
|
||||
### Example
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Acme Corporation",
|
||||
"logoUrl": "https://acme.com/logo.svg",
|
||||
"url": "https://acme.com",
|
||||
"description": "Using LiteLLM to route requests across 50+ LLM providers"
|
||||
}
|
||||
```
|
||||
|
||||
### Display Order
|
||||
|
||||
Adopters are displayed alphabetically by organization name, so your position will be determined automatically.
|
||||
|
||||
### Need Help?
|
||||
|
||||
If you have questions about adding your organization:
|
||||
|
||||
- Ask in [GitHub Discussions](https://github.com/BerriAI/litellm/discussions)
|
||||
- Join our [Discord community](https://discord.com/invite/wuPM9dRgDw)
|
||||
|
||||
Thank you for supporting LiteLLM! 🚅
|
||||
8
docs/my-website/src/data/adopters/adopters.json
Normal file
8
docs/my-website/src/data/adopters/adopters.json
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
[
|
||||
{
|
||||
"name": "Your Logo Here",
|
||||
"logoUrl": "/img/adopters/placeholder-company.svg",
|
||||
"description": "Add your organization to show support for LiteLLM",
|
||||
"url": "https://github.com/BerriAI/litellm/edit/main/docs/my-website/src/data/adopters/adopters.json"
|
||||
}
|
||||
]
|
||||
23
docs/my-website/src/data/adopters/index.js
Normal file
23
docs/my-website/src/data/adopters/index.js
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
import adoptersData from './adopters.json';
|
||||
|
||||
/**
|
||||
* @typedef {Object} Adopter
|
||||
* @property {string} name - The organization's display name
|
||||
* @property {string} logoUrl - URL to the organization's logo
|
||||
* @property {string} [url] - The organization's website URL
|
||||
* @property {string} [description] - Brief description shown on hover
|
||||
*/
|
||||
|
||||
/**
|
||||
* List of organizations using LiteLLM
|
||||
* @type {Adopter[]}
|
||||
*/
|
||||
export const adopters = adoptersData;
|
||||
|
||||
/**
|
||||
* Adopters sorted alphabetically by name
|
||||
* @type {Adopter[]}
|
||||
*/
|
||||
export const sortedAdopters = [...adopters].sort((a, b) =>
|
||||
a.name.localeCompare(b.name)
|
||||
);
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
<svg width="240" height="160" viewBox="0 0 240 160" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<rect width="240" height="160" rx="8" fill="#f8fafc"/>
|
||||
<rect x="1" y="1" width="238" height="158" rx="7" stroke="#e2e8f0" stroke-width="2" stroke-dasharray="8 4"/>
|
||||
<circle cx="120" cy="60" r="24" fill="#e2e8f0"/>
|
||||
<path d="M120 48v24M108 60h24" stroke="#94a3b8" stroke-width="3" stroke-linecap="round"/>
|
||||
<text x="120" y="110" text-anchor="middle" fill="#64748b" font-family="system-ui, -apple-system, sans-serif" font-size="14" font-weight="500">Add Your Logo</text>
|
||||
<text x="120" y="130" text-anchor="middle" fill="#94a3b8" font-family="system-ui, -apple-system, sans-serif" font-size="11">Click to contribute</text>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 736 B |
Loading…
Add table
Reference in a new issue