Version Packages

Open fuma-nama opened this issue 1 year ago • 1 comments

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to dev, this PR will be updated.

Releases

[email protected]

Major Changes

e45bc67: Remove deprecated fumadocs-core/middleware export

migrate: Use fumadocs-core/i18n.
d9e908e: Remove deprecated languages and defaultLanguage option from loader

migrate: Use I18n config API

9a0b09f: Change usage of useDocsSearch

why: Allow static search

migrate:

Pass client option, it can be algolia, static, or fetch (default).

import { useDocsSearch } from 'fumadocs-core/search/client';

const { search, setSearch, query } = useDocsSearch({
  type: 'fetch',
  api: '/api/search', // optional
});

9a0b09f: Remove Algolia Search Client

why: Replace by the new search client

migrate:

import { useDocsSearch } from 'fumadocs-core/search/client';

const { search, setSearch, query } = useDocsSearch({
  type: 'algolia',
  index,
  ...searchOptions,
});

9a0b09f: Refactor import path of fumadocs-core/search-algolia/server to fumadocs-core/search/algolia
d9e908e: Improved usage for createI18nSearchAPI (replaced createI18nSearchAPIExperimental)
d9e908e: Replace fumadocs-core/search/shared with fumadocs-core/server

Minor Changes

d9e908e: Create search api from source (Support i18n without modifying search route handler)
367f4c3: Support referencing original page/meta from page tree nodes
e1ee822: Support hast nodes in toc variable
979e301: Replace flexearch with Orama
979e301: Support static search (without server)
d9e908e: Support creating metadata API from sources

Patch Changes

f949520: Support Shiki diff transformer
e612f2a: Make compatible with Next.js 15
8ef00dc: Apply hideLocale to Source getPage APIs
15781f0: Fix breadcrumb empty when includePage isn't specified
be820c4: Bump deps

[email protected]

Major Changes

9a10262: Move Twoslash UI components to fumadocs-twoslash

why: Isolate logic from Fumadocs UI

migrate:

Before:

import 'fumadocs-ui/twoslash.css';

import { Popup } from 'fumadocs-ui/twoslash/popup';

After:

import 'fumadocs-twoslash/twoslash.css';

import { Popup } from 'fumadocs-twoslash/ui';

Tailwind CSS is now required for Twoslash integration.

Patch Changes

be820c4: Bump deps
Updated dependencies [34cf456]
Updated dependencies [d9e908e]
Updated dependencies [f949520]
Updated dependencies [ad47fd8]
Updated dependencies [d9e908e]
Updated dependencies [367f4c3]
Updated dependencies [87063eb]
Updated dependencies [e1ee822]
Updated dependencies [d9e908e]
Updated dependencies [d9e908e]
Updated dependencies [e612f2a]
Updated dependencies [3d0369a]
Updated dependencies [9a10262]
Updated dependencies [d9e908e]
Updated dependencies [d9e908e]
Updated dependencies [be820c4]
Updated dependencies [be53a0e]
- [email protected]

[email protected]

Major Changes

d9e908e: Refactor import paths for layouts

migrate: Use

import { DocsLayout } from 'fumadocs-ui/layouts/docs';

import { HomeLayout } from 'fumadocs-ui/layouts/home';

import { BaseLayoutProps } from 'fumadocs-ui/layouts/shared';

Instead of

import { DocsLayout } from 'fumadocs-ui/layout';

import { HomeLayout } from 'fumadocs-ui/home-layout';

import { HomeLayoutProps } from 'fumadocs-ui/home-layout';

9a10262: Move Twoslash UI components to fumadocs-twoslash

why: Isolate logic from Fumadocs UI

migrate:

Before:

import 'fumadocs-ui/twoslash.css';

import { Popup } from 'fumadocs-ui/twoslash/popup';

After:

import 'fumadocs-twoslash/twoslash.css';

import { Popup } from 'fumadocs-twoslash/ui';

Tailwind CSS is now required for Twoslash integration.

d9e908e: Remove getImageMeta from fumadocs-ui/og

migrate: Use Metadata API from fumadocs-core/server
d9e908e: Replace fumadocs-core/search/shared with fumadocs-core/server
be53a0e: DocsCategory now accept from prop instead of pages prop.

why: This allows sharing the order of items with page tree. migrate:

The component now takes from prop which is the Source API object.
```
import { source } from '@/lib/source';
import { DocsCategory } from 'fumadocs-ui/page';

const page = source.getPage(params.slug);

<DocsCategory page={page} from={source} />;
```