跳至內容
Fumadocs

更新日誌

展示您專案的版本發布紀錄。

安裝

請安裝時間軸 (timeline) 元件,這會將 @fumadocs/changelog 加入您的相依套件:

npx @fumadocs/cli@latest add changelog

使用方式

請在您的首頁版面配置下建立一個頁面。先取得一頁的條目,再以 ChangelogTimeline 算繪,並透過 ChangelogPagination 連結至其他頁面:

src/routes/changelog.{-$page}.tsx
import { createFileRoute, notFound } from '@tanstack/react-router';
import { createServerFn } from '@tanstack/react-start';
import { HomeLayout } from 'fumadocs-ui/layouts/home';
import { githubReleases } from '@fumadocs/changelog/github';
import { baseOptions } from '@/lib/layout.shared';
import { ChangelogPagination, ChangelogTimeline } from '@/components/changelog';

const getReleases = createServerFn({ method: 'GET' })
  .validator((page: number) => page)
  .handler(async ({ data: page }) => {
    const releases = await githubReleases({
      owner: 'fuma-nama',
      repo: 'fumadocs',
      token: process.env.GITHUB_TOKEN,
      page,
    });
    if (releases.entries.length === 0) throw notFound();

    return releases;
  });

export const Route = createFileRoute('/changelog/{-$page}')({
  loader: async ({ params }) => {
    const page = Number(params.page ?? 1);
    return { page, ...(await getReleases({ data: page })) };
  },
  component: Page,
});

function Page() {
  const { page, entries, nextPage } = Route.useLoaderData();

  return (
    <HomeLayout {...baseOptions()}>
      <div className="mx-auto flex w-full max-w-[900px] flex-col gap-10 px-4 py-12">
        <ChangelogTimeline entries={entries} />
        <ChangelogPagination
          newer={page > 1 ? `/changelog/${page - 1}` : undefined}
          older={nextPage ? `/changelog/${nextPage}` : undefined}
        />
      </div>
    </HomeLayout>
  );
}

來源

GitHub Releases

githubReleases() 會回傳儲存庫已發布版本中的一頁,若還有較舊的版本,則會附上 nextPage。

  • 版本號會從發布名稱 (例如 fumadocs-ui@16.17.0) 或其標籤中讀取。
  • 預先發布版本的項目會帶有 prerelease 屬性。
  • GitHub 將未經驗證的請求限制為每小時 60 次。請傳入 token 並快取該頁面。
  • GitHub 只會列出前 1000 個發布版本,使用 token 時則為 10000 個。超出範圍的頁面不會有任何項目。

屬性

型別

自訂項目

項目是純物件,您可以從任何來源建立:

屬性

型別

項目會以資料形式從載入器傳到頁面,因此請在 content 中以 Markdown 撰寫內容,而不要在 body 中使用 React 節點。

How is this guide?

最後更新於