aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorShinigami <[email protected]>2022-03-25 16:38:24 +0100
committerGitHub <[email protected]>2022-03-25 16:38:24 +0100
commit3252c7ea0421ead864fd41f4239e1b80f22c29bf (patch)
tree3240c3d07749e2ce277ba5a937ec490921c8e167 /docs
parentc1c60649ee554f81887ab618ae8b2e2bd5a27d55 (diff)
downloadfaker-3252c7ea0421ead864fd41f4239e1b80f22c29bf.tar.xz
faker-3252c7ea0421ead864fd41f4239e1b80f22c29bf.zip
docs: convert to typescript (#658)
Diffstat (limited to 'docs')
-rw-r--r--docs/.vitepress/.gitignore2
-rw-r--r--docs/.vitepress/config.ts (renamed from docs/.vitepress/config.mjs)9
-rw-r--r--docs/.vitepress/theme/components/index.ts (renamed from docs/.vitepress/theme/components/index.mjs)0
-rw-r--r--docs/.vitepress/theme/components/vue.d.ts4
-rw-r--r--docs/.vitepress/theme/index.ts (renamed from docs/.vitepress/theme/index.mjs)0
5 files changed, 10 insertions, 5 deletions
diff --git a/docs/.vitepress/.gitignore b/docs/.vitepress/.gitignore
index 1af560a8..3b0c8abc 100644
--- a/docs/.vitepress/.gitignore
+++ b/docs/.vitepress/.gitignore
@@ -1 +1 @@
-api-pages.mjs
+api-pages.ts
diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.ts
index 8c15b49d..ade58400 100644
--- a/docs/.vitepress/config.mjs
+++ b/docs/.vitepress/config.ts
@@ -1,7 +1,8 @@
+import type { DefaultTheme } from 'vitepress';
import { defineConfig } from 'vitepress';
-import { apiPages } from './api-pages.mjs';
+import { apiPages } from './api-pages';
-const nav = [
+const nav: DefaultTheme.NavItem[] = [
{ text: 'Guide', link: '/guide/' },
{
text: 'Ecosystem',
@@ -14,7 +15,7 @@ const nav = [
// { text: 'Playground', link: '/playground/' },
];
-const sidebar = {
+const sidebar: DefaultTheme.MultiSideBarConfig = {
'/': [
{
text: 'Guide',
@@ -40,7 +41,7 @@ const sidebar = {
],
};
-const algolia = {
+const algolia: DefaultTheme.AlgoliaSearchOptions = {
apiKey: process.env.API_KEY,
appId: process.env.APP_ID,
indexName: 'fakerjs',
diff --git a/docs/.vitepress/theme/components/index.mjs b/docs/.vitepress/theme/components/index.ts
index 4b77998a..4b77998a 100644
--- a/docs/.vitepress/theme/components/index.mjs
+++ b/docs/.vitepress/theme/components/index.ts
diff --git a/docs/.vitepress/theme/components/vue.d.ts b/docs/.vitepress/theme/components/vue.d.ts
new file mode 100644
index 00000000..939fef48
--- /dev/null
+++ b/docs/.vitepress/theme/components/vue.d.ts
@@ -0,0 +1,4 @@
+declare module '*.vue' {
+ const component: any;
+ export default component;
+}
diff --git a/docs/.vitepress/theme/index.mjs b/docs/.vitepress/theme/index.ts
index e4f3534f..e4f3534f 100644
--- a/docs/.vitepress/theme/index.mjs
+++ b/docs/.vitepress/theme/index.ts