# Shiori

A clean, minimal Open Graph image with a light cream background, a circular logo, and a bold brand beside a muted title.

> For the complete documentation index, see [llms.txt](/llms.txt). Markdown variants are available by appending `.md` to any URL or sending an `Accept: text/markdown` header. An agent skill is available at [/.well-known/agent-skills/site-skill.md](/.well-known/agent-skills/site-skill.md).



<ComponentPreview name="shiori" />

## Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @ogimagecn/shiori
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource name="shiori" title="components/og/shiori.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

## Usage [#usage]

```tsx
import { ImageResponse } from "next/og";

import { Shiori } from "@/components/og/shiori";

export function GET() {
  return new ImageResponse(
    <Shiori
      title="A beautifully simple read-it-later app"
      background="#faf6f1"
      titleColor="#8b7e74"
      logo="https://www.shiori.sh/logo.png"
      brand="Shiori"
      brandColor="#1a1a1a"
    />,
    { width: 1200, height: 630 }
  );
}
```

## API Reference [#api-reference]

### Shiori [#shiori]

| Prop         | Type     |
| ------------ | -------- |
| `title`      | `string` |
| `background` | `string` |
| `titleColor` | `string` |
| `logo`       | `string` |
| `brand`      | `string` |
| `brandColor` | `string` |