Merge pull request #251 from hey-api/chore/support-i18n-in-docs

chore(docs): add support for localization

.changeset/quiet-schools-matter.md

@@ -0,0 +1,5 @@
+---
+"openapi-ts-docs": minor
+---
+
+docs: add support for localization of docs

README.md

@@ -1,6 +1,8 @@
-# OpenAPI TypeScript 👋
-
-✨ Turn your OpenAPI specification into a beautiful TypeScript client
+<div align="center">
+    <img width="150" height="150" src="./docs/public/logo.png" alt="Logo">
+    <h1 align="center"><b>OpenAPI Typescript</b></h1>
+    <p align="center">✨ Turn your OpenAPI specification into a beautiful TypeScript client.</p>
+</div>
 
 ## About
 

docs/.vitepress/config.ts → docs/.vitepress/config/en.ts

@@ -1,15 +1,9 @@
-import { defineConfig } from 'vitepress'
+import { defineConfig } from 'vitepress';
 
-// https://vitepress.dev/reference/site-config
 export default defineConfig({
-    title: "OpenAPI TypeScript",
-    description: "Turn your OpenAPI specification into a beautiful TypeScript client",
-    head: [
-        ['link', { rel: 'icon', type: 'image/png', href: '/logo.png' }],
-    ],
+    lang: 'en-US',
+    description: 'Turn your OpenAPI specification into a beautiful TypeScript client',
     themeConfig: {
-        // https://vitepress.dev/reference/default-theme-config
-        logo: '/logo.png',
         nav: [
             { text: 'Guide', link: '/introduction' },
         ],
@@ -23,11 +17,8 @@ export default defineConfig({
                     { text: 'Configuration', link: '/configuration' },
                     { text: 'Interceptors', link: '/interceptors' },
                     { text: 'Migrating', link: '/migrating' },
-                ]
-            }
+                ],
+            },
         ],
-        socialLinks: [
-            { icon: 'github', link: 'https://github.com/hey-api/openapi-ts' }
-        ]
-    }
-})
+    },
+});

docs/.vitepress/config/index.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from 'vitepress';
+
+import en from './en';
+import shared from './shared';
+
+export default defineConfig({
+    ...shared,
+    locales: {
+        root: { label: 'English', ...en },
+    },
+});

docs/.vitepress/config/shared.ts

@@ -0,0 +1,19 @@
+import { defineConfig } from 'vitepress';
+
+export default defineConfig({
+    title: 'OpenAPI TypeScript',
+    lastUpdated: true,
+    sitemap: {
+        hostname: 'https://heyapi.vercel.app',
+    },
+    head: [
+        ['link', { rel: 'icon', type: 'image/png', href: '/logo.png' }],
+    ],
+    themeConfig: {
+        logo: '/logo.png',
+        socialLinks: [
+            { icon: 'npm', link: 'https://www.npmjs.com/package/@hey-api/openapi-ts' },
+            { icon: 'github', link: 'https://github.com/hey-api/openapi-ts' },
+        ],
+    }
+});

docs/index.md

@@ -1,5 +1,4 @@
 ---
-# https://vitepress.dev/reference/default-theme-home-page
 layout: home
 
 hero: