---
title: GitHub Info
description: Display your GitHub repository information
preview: githubInfo
---

<Installation name="github-info" />

## Usage

```tsx
import { GithubInfo } from 'fumadocs-ui/components/github-info';

export function MyComp() {
  return (
    <GithubInfo
      owner="fuma-nama"
      repo="fumadocs"
      // your own GitHub access token (optional)
      token={process.env.GITHUB_TOKEN}
    />
  );
}
```

It's recommended to add it to your docs layout with `links` option:

```tsx title="app/docs/layout.tsx"
import { DocsLayout, type DocsLayoutProps } from 'fumadocs-ui/layouts/notebook';
import { baseOptions } from '@/lib/layout.shared';
import { source } from '@/lib/source';
import { GithubInfo } from 'fumadocs-ui/components/github-info';

function docsOptions(): DocsLayoutProps {
  return {
    ...baseOptions(),
    tree: source.getPageTree(),
    links: [
      {
        type: 'custom',
        children: <GithubInfo owner="fuma-nama" repo="fumadocs" />,
      },
    ],
  };
}

export default function Layout({ children }: { children: React.ReactNode }) {
  return <DocsLayout {...docsOptions()}>{children}</DocsLayout>;
}
```
