Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Version Packages #281

Merged
merged 1 commit into from
Mar 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .changeset/gorgeous-flies-burn.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/healthy-humans-search.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/tiny-lions-chew.md

This file was deleted.

6 changes: 3 additions & 3 deletions examples/contentlayer/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
},
"dependencies": {
"contentlayer": "0.3.4",
"fumadocs-contentlayer": "1.1.2",
"fumadocs-core": "10.0.1",
"fumadocs-ui": "10.0.1",
"fumadocs-contentlayer": "1.1.3",
"fumadocs-core": "10.0.2",
"fumadocs-ui": "10.0.2",
"next": "14.1.2",
"next-contentlayer": "0.3.4",
"react": "18.2.0",
Expand Down
6 changes: 3 additions & 3 deletions examples/next-mdx/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
"start": "next start"
},
"dependencies": {
"fumadocs-core": "10.0.1",
"fumadocs-mdx": "8.2.0",
"fumadocs-ui": "10.0.1",
"fumadocs-core": "10.0.2",
"fumadocs-mdx": "8.2.1",
"fumadocs-ui": "10.0.2",
"next": "14.1.2",
"react": "18.2.0",
"react-dom": "18.2.0"
Expand Down
7 changes: 7 additions & 0 deletions packages/contentlayer/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# fumadocs-contentlayer

## 1.1.3

### Patch Changes

- Updated dependencies [10e099a]
- [email protected]

## 1.1.2

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/contentlayer/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "fumadocs-contentlayer",
"version": "1.1.2",
"version": "1.1.3",
"description": "The Contentlayer adapter for Fumadocs",
"keywords": [
"NextJs",
Expand Down
32 changes: 19 additions & 13 deletions packages/core/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# next-docs-zeta

## 10.0.2

### Patch Changes

- 10e099a: Remove deprecated options from `fumadocs-core/toc`

## 10.0.1

### Patch Changes
Expand Down Expand Up @@ -74,7 +80,7 @@

````md
```ts /config/ {1}
const config = 'Hello';
const config = "Hello";

something.call(config);
```
Expand All @@ -85,7 +91,7 @@
````md
```ts
// [!code word:config]
const config = 'Hello'; // [!code highlight]
const config = "Hello"; // [!code highlight]

something.call(config);
```
Expand Down Expand Up @@ -144,13 +150,13 @@
It's no longer encouraged to access `allDocs` directly because they will not include `url` property anymore. Please consider `getPages` instead.

```ts
import { allDocs, allMeta } from 'contentlayer/generated';
import { createContentlayerSource } from 'next-docs-zeta/contentlayer';
import { loader } from 'next-docs-zeta/source';
import { allDocs, allMeta } from "contentlayer/generated";
import { createContentlayerSource } from "next-docs-zeta/contentlayer";
import { loader } from "next-docs-zeta/source";

export const { getPage, pageTree, getPages } = loader({
baseUrl: '/docs',
rootDir: 'docs',
baseUrl: "/docs",
rootDir: "docs",
source: createContentlayerSource(allMeta, allDocs),
});
```
Expand All @@ -171,13 +177,13 @@
The interface is now unified, you can easily plug in a content source.

```ts
import { map } from '@/.map';
import { createMDXSource } from 'next-docs-mdx';
import { loader } from 'next-docs-zeta/source';
import { map } from "@/.map";
import { createMDXSource } from "next-docs-mdx";
import { loader } from "next-docs-zeta/source";

export const { getPage, getPages, pageTree } = loader({
baseUrl: '/docs',
rootDir: 'docs',
baseUrl: "/docs",
rootDir: "docs",
source: createMDXSource(map),
});
```
Expand Down Expand Up @@ -221,7 +227,7 @@
If you want to include other document types, or override the output configuration, the `create` function can return the fields and document types you need.

```ts
import { create } from 'next-docs-zeta/contentlayer/configuration';
import { create } from "next-docs-zeta/contentlayer/configuration";

const config = create(options);

Expand Down
2 changes: 1 addition & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "fumadocs-core",
"version": "10.0.1",
"version": "10.0.2",
"description": "The library for building a documentation website in Next.js",
"keywords": [
"NextJs",
Expand Down
2 changes: 2 additions & 0 deletions packages/create-app/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# create-next-docs-app

## 10.0.2

## 10.0.1

## 10.0.0
Expand Down
2 changes: 1 addition & 1 deletion packages/create-app/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "create-fumadocs-app",
"version": "10.0.1",
"version": "10.0.2",
"description": "Create a new documentation site with Fumadocs",
"keywords": [
"NextJs",
Expand Down
31 changes: 19 additions & 12 deletions packages/mdx/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# next-docs-mdx

## 8.2.1

### Patch Changes

- Updated dependencies [10e099a]
- [email protected]

## 8.2.0

### Minor Changes
Expand Down Expand Up @@ -85,7 +92,7 @@
Become:

```mdx
import img_banner from '../../public/image.png';
import img_banner from "../../public/image.png";

<img alt="banner" src={img_banner} />
```
Expand Down Expand Up @@ -146,13 +153,13 @@
`fromMap` has been removed. Please use `createMDXSource` instead.

```ts
import { map } from '@/.map';
import { createMDXSource } from 'next-docs-mdx';
import { loader } from 'next-docs-zeta/source';
import { map } from "@/.map";
import { createMDXSource } from "next-docs-mdx";
import { loader } from "next-docs-zeta/source";

export const { getPage, getPages, pageTree } = loader({
baseUrl: '/docs',
rootDir: 'docs',
baseUrl: "/docs",
rootDir: "docs",
source: createMDXSource(map),
});
```
Expand All @@ -166,7 +173,7 @@
```js
const withNextDocs = createNextDocs({
mdxOptions: {
lastModifiedTime: 'git',
lastModifiedTime: "git",
},
});
```
Expand Down Expand Up @@ -215,7 +222,7 @@

```ts
const utils = fromMap(map, {
rootDir: 'ui',
rootDir: "ui",
schema: {
frontmatter: frontmatterSchema,
},
Expand Down Expand Up @@ -246,11 +253,11 @@
The `validate` options is now renamed to `schema`.

```ts
import { defaultSchemas, fromMap } from 'next-docs-mdx/map';
import { defaultSchemas, fromMap } from "next-docs-mdx/map";

const utils = fromMap(map, {
rootDir: 'docs/ui',
baseUrl: '/docs/ui',
rootDir: "docs/ui",
baseUrl: "/docs/ui",
schema: {
frontmatter: defaultSchemas.frontmatter.extend({
preview: z.string().optional(),
Expand All @@ -269,7 +276,7 @@

```js
const withNextDocs = createNextDocs({
rootContentPath: './content/docs',
rootContentPath: "./content/docs",
});
```

Expand Down
2 changes: 1 addition & 1 deletion packages/mdx/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "fumadocs-mdx",
"version": "8.2.0",
"version": "8.2.1",
"description": "The built-in source for Fumadocs",
"keywords": [
"NextJs",
Expand Down
6 changes: 6 additions & 0 deletions packages/typescript/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# fumadocs-typescript

## 1.0.1

### Patch Changes

- f4aa6b6: Ignore fields marked with `@internal` tag

## 1.0.0

### Major Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/typescript/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "fumadocs-typescript",
"version": "1.0.0",
"version": "1.0.1",
"description": "Typescript Integration for Fumadocs",
"keywords": [
"NextJs",
Expand Down
44 changes: 26 additions & 18 deletions packages/ui/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# next-docs-ui

## 10.0.2

### Patch Changes

- 10e099a: Add scrollbar to TOC
- Updated dependencies [10e099a]
- [email protected]

## 10.0.1

### Patch Changes
Expand Down Expand Up @@ -142,8 +150,8 @@
<I18nProvider
translations={{
cn: {
name: 'Chinese', // required
search: 'Translated Content',
name: "Chinese", // required
search: "Translated Content",
},
}}
></I18nProvider>
Expand All @@ -156,15 +164,15 @@
migrate: Use `createPreset` instead

```js
const { createPreset } = require('fumadocs-ui/tailwind-plugin');
const { createPreset } = require("fumadocs-ui/tailwind-plugin");

/** @type {import('tailwindcss').Config} */
module.exports = {
content: [
'./components/**/*.{ts,tsx}',
'./app/**/*.{ts,tsx}',
'./content/**/*.mdx',
'./node_modules/fumadocs-ui/dist/**/*.js',
"./components/**/*.{ts,tsx}",
"./app/**/*.{ts,tsx}",
"./content/**/*.mdx",
"./node_modules/fumadocs-ui/dist/**/*.js",
],
presets: [createPreset()],
};
Expand All @@ -177,15 +185,15 @@
Before:

```tsx
import { CodeBlock, Pre } from 'fumadocs-ui/mdx/pre';
import { CodeBlock, Pre } from "fumadocs-ui/mdx/pre";

<Pre title={title} allowCopy {...props} />;
```

After:

```tsx
import { CodeBlock, Pre } from 'fumadocs-ui/components/codeblock';
import { CodeBlock, Pre } from "fumadocs-ui/components/codeblock";

<CodeBlock title={title} allowCopy>
<Pre {...props} />
Expand Down Expand Up @@ -306,14 +314,14 @@
Add theme presets for the Tailwind CSS plugin, the default and ocean presets are available now.

```js
const { docsUi, docsUiPlugins } = require('next-docs-ui/tailwind-plugin');
const { docsUi, docsUiPlugins } = require("next-docs-ui/tailwind-plugin");

/** @type {import('tailwindcss').Config} */
module.exports = {
plugins: [
...docsUiPlugins,
docsUi({
preset: 'ocean',
preset: "ocean",
}),
],
};
Expand Down Expand Up @@ -349,7 +357,7 @@
Same as Docs Layout but doesn't include a sidebar. It can be used outside of the docs, a page tree is not required.

```jsx
import { Layout } from 'next-docs-ui/layout';
import { Layout } from "next-docs-ui/layout";

export default function HomeLayout({ children }) {
return <Layout>{children}</Layout>;
Expand Down Expand Up @@ -406,16 +414,16 @@
If you are using Tailwind CSS for your docs, it's now recommended to use the official plugin instead.

```js
const { docsUi, docsUiPlugins } = require('next-docs-ui/tailwind-plugin');
const { docsUi, docsUiPlugins } = require("next-docs-ui/tailwind-plugin");

/** @type {import('tailwindcss').Config} */
module.exports = {
darkMode: 'class',
darkMode: "class",
content: [
'./components/**/*.{ts,tsx}',
'./app/**/*.{ts,tsx}',
'./content/**/*.mdx',
'./node_modules/next-docs-ui/dist/**/*.js',
"./components/**/*.{ts,tsx}",
"./app/**/*.{ts,tsx}",
"./content/**/*.mdx",
"./node_modules/next-docs-ui/dist/**/*.js",
],
plugins: [...docsUiPlugins, docsUi],
};
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "fumadocs-ui",
"version": "10.0.1",
"version": "10.0.2",
"description": "The framework for building a documentation website in Next.js",
"keywords": [
"NextJs",
Expand Down
Loading