Skip to content
Open
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
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,16 @@ NextGlobeGen makes it effortless to deliver your content in multiple languages w

NextGlobeGen is a powerful TypeScript-first internationalization (i18n) library for Next.js App Router applications. Unlike traditional i18n solutions, NextGlobeGen uses **generative programming** to automatically create localized routes and type-safe APIs, giving you a seamless development experience with full TypeScript support.

## Getting Started

Ready to internationalize your Next.js app? Follow our [Getting Started Guide](https://next-globe-gen.dev/docs/getting-started) to set up NextGlobeGen in minutes.

## Required Versions

- Node.js: ^22.12.0
- Next.js: ^15.3.0 || ^16.0.0
- React: ^19.0.0

## Why NextGlobeGen?

### 🎯 Developer Experience First
Expand Down Expand Up @@ -206,10 +216,6 @@ export async function generateMetadata() {
}
```

## Getting Started

Ready to internationalize your Next.js app? Follow our [Getting Started Guide](https://next-globe-gen.dev/docs/getting-started) to set up NextGlobeGen in minutes.

### Coming from next-intl?
## Coming from next-intl?

If you're familiar with next-intl or considering alternatives, check out our [detailed comparison](https://next-globe-gen.dev/docs/comparison-with-next-intl) to understand the differences and see which approach fits your project best.
39 changes: 6 additions & 33 deletions docs/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,29 +13,19 @@ If you haven't done so already, [create a new Next.js app](https://nextjs.org/do

## Installation

<details>
<summary>
Next.js 15+
</summary>
A version of the package which is compatible with Next.js 15+ is released under the `latest` distribution tag. To install this version of the package, run the following command.
To install the latest version of the package, run the following command.

```bash npm2yarn
npm install next-globe-gen@latest
```

</details>
:::info Required Versions

<details>
<summary>
Next.js 14
</summary>
A version of the package which is compatible with Next.js 14 is released under `next-14` distribution tag. To install this version of the package, run the following command.
- Node.js: ^22.12.0
- Next.js: ^15.3.0 || ^16.0.0
- React: ^19.0.0

```bash npm2yarn
npm install next-globe-gen@next-14
```

</details>
:::

## Setup

Expand Down Expand Up @@ -115,23 +105,6 @@ const nextConfig: NextConfig = {
export default withNextGlobeGen(nextConfig);
```

</TabItem>
<TabItem value="next.config.js">

```ts
// @ts-check
const createNextGlobeGenPlugin = require("next-globe-gen/plugin");

const withNextGlobeGen = createNextGlobeGenPlugin();

/** @type {import('next').NextConfig} */
const nextConfig: NextConfig = {
/* Next.js config options here */
};

module.exports = withNextGlobeGen(nextConfig);
```

</TabItem>
</Tabs>

Expand Down
1 change: 0 additions & 1 deletion docs/eslint.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ export default defineConfig(
{ languageOptions: { globals: { ...globals.node } } },
eslint.configs.recommended,
tseslint.configs.recommended,
// @ts-expect-error Wrong types
compat.extends("plugin:@docusaurus/recommended"),
{ linterOptions: { reportUnusedDisableDirectives: true } },
);
43 changes: 22 additions & 21 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,32 +19,33 @@
"check:format": "prettier --check ."
},
"dependencies": {
"@docusaurus/core": "3.9.2",
"@docusaurus/preset-classic": "3.9.2",
"@docusaurus/remark-plugin-npm2yarn": "^3.9.2",
"@docusaurus/core": "3.10.1",
"@docusaurus/preset-classic": "3.10.1",
"@docusaurus/remark-plugin-npm2yarn": "^3.10.1",
"@mdx-js/react": "^3.1.1",
"clsx": "^2.1.1",
"prism-react-renderer": "^2.4.1",
"react": "^19.2.3",
"react-dom": "^19.2.3",
"tailwind-merge": "^3.4.0"
"react": "^19.2.6",
"react-dom": "^19.2.6",
"tailwind-merge": "^3.6.0"
},
"devDependencies": {
"@docusaurus/eslint-plugin": "^3.9.2",
"@docusaurus/module-type-aliases": "3.9.2",
"@docusaurus/tsconfig": "3.9.2",
"@docusaurus/types": "3.9.2",
"@eslint/eslintrc": "^3.3.3",
"@eslint/js": "^9.39.2",
"@tailwindcss/postcss": "^4.1.18",
"eslint": "^9.39.2",
"globals": "^17.0.0",
"postcss": "^8.5.6",
"prettier": "^3.7.4",
"prettier-plugin-tailwindcss": "^0.7.2",
"tailwindcss": "^4.1.18",
"typescript": "^5.9.3",
"typescript-eslint": "^8.52.0"
"@docusaurus/eslint-plugin": "^3.10.1",
"@docusaurus/module-type-aliases": "3.10.1",
"@docusaurus/tsconfig": "3.10.1",
"@docusaurus/types": "3.10.1",
"@eslint/eslintrc": "^3.3.5",
"@eslint/js": "^9.39.4",
"@tailwindcss/postcss": "^4.3.0",
"@types/react": "^19.2.15",
"eslint": "^9.39.4",
"globals": "^17.6.0",
"postcss": "^8.5.15",
"prettier": "^3.8.3",
"prettier-plugin-tailwindcss": "^0.8.0",
"tailwindcss": "^4.3.0",
"typescript": "^6.0.3",
"typescript-eslint": "^8.60.0"
},
"browserslist": {
"production": [
Expand Down
Loading
Loading