From 3252c7ea0421ead864fd41f4239e1b80f22c29bf Mon Sep 17 00:00:00 2001 From: Shinigami Date: Fri, 25 Mar 2022 16:38:24 +0100 Subject: docs: convert to typescript (#658) --- docs/.vitepress/.gitignore | 2 +- docs/.vitepress/config.mjs | 113 ---------------------------- docs/.vitepress/config.ts | 114 +++++++++++++++++++++++++++++ docs/.vitepress/theme/components/index.mjs | 7 -- docs/.vitepress/theme/components/index.ts | 7 ++ docs/.vitepress/theme/components/vue.d.ts | 4 + docs/.vitepress/theme/index.mjs | 12 --- docs/.vitepress/theme/index.ts | 12 +++ 8 files changed, 138 insertions(+), 133 deletions(-) delete mode 100644 docs/.vitepress/config.mjs create mode 100644 docs/.vitepress/config.ts delete mode 100644 docs/.vitepress/theme/components/index.mjs create mode 100644 docs/.vitepress/theme/components/index.ts create mode 100644 docs/.vitepress/theme/components/vue.d.ts delete mode 100644 docs/.vitepress/theme/index.mjs create mode 100644 docs/.vitepress/theme/index.ts (limited to 'docs') 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.mjs deleted file mode 100644 index 8c15b49d..00000000 --- a/docs/.vitepress/config.mjs +++ /dev/null @@ -1,113 +0,0 @@ -import { defineConfig } from 'vitepress'; -import { apiPages } from './api-pages.mjs'; - -const nav = [ - { text: 'Guide', link: '/guide/' }, - { - text: 'Ecosystem', - items: [ - { text: 'Discord', link: 'https://chat.fakerjs.dev' }, - { text: 'StackBlitz', link: 'https://fakerjs.dev/new' }, - { text: 'Twitter', link: 'https://twitter.com/faker_js' }, - ], - }, - // { text: 'Playground', link: '/playground/' }, -]; - -const sidebar = { - '/': [ - { - text: 'Guide', - children: [ - { - text: 'Recent Statement and FAQs', - link: '/update.html', - }, - { - text: 'Getting Started', - link: '/guide/', - }, - ], - }, - { - text: 'API', - children: apiPages, - }, - { - text: 'Migrating from Faker v5', - link: '/migration-guide-v5/', - }, - ], -}; - -const algolia = { - apiKey: process.env.API_KEY, - appId: process.env.APP_ID, - indexName: 'fakerjs', -}; - -const description = - 'Generate massive amounts of fake (but reasonable) data for testing and development.'; -const image = 'https://fakerjs.dev/social-image.png'; - -export default defineConfig({ - title: 'Faker', - description, - head: [ - ['link', { rel: 'icon', href: '/logo.svg' }], - ['meta', { name: 'theme-color', content: '#40af7c' }], - [ - 'meta', - { - name: 'og:description', - content: description, - }, - ], - [ - 'meta', - { - name: 'twitter:description', - content: description, - }, - ], - [ - 'meta', - { - name: 'description', - content: description, - }, - ], - [ - 'meta', - { - name: 'og:image', - content: image, - }, - ], - [ - 'meta', - { - name: 'twitter:image', - content: image, - }, - ], - [ - 'meta', - { - name: 'twitter:card', - content: 'summary_large_image', - }, - ], - ], - themeConfig: { - repo: 'faker-js/faker', - logo: '/logo.svg', - docsDir: 'docs', - docsBranch: 'main', - editLinks: true, - editLinkText: 'Suggest changes to this page', - nav, - sidebar, - algolia, - }, -}); diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts new file mode 100644 index 00000000..ade58400 --- /dev/null +++ b/docs/.vitepress/config.ts @@ -0,0 +1,114 @@ +import type { DefaultTheme } from 'vitepress'; +import { defineConfig } from 'vitepress'; +import { apiPages } from './api-pages'; + +const nav: DefaultTheme.NavItem[] = [ + { text: 'Guide', link: '/guide/' }, + { + text: 'Ecosystem', + items: [ + { text: 'Discord', link: 'https://chat.fakerjs.dev' }, + { text: 'StackBlitz', link: 'https://fakerjs.dev/new' }, + { text: 'Twitter', link: 'https://twitter.com/faker_js' }, + ], + }, + // { text: 'Playground', link: '/playground/' }, +]; + +const sidebar: DefaultTheme.MultiSideBarConfig = { + '/': [ + { + text: 'Guide', + children: [ + { + text: 'Recent Statement and FAQs', + link: '/update.html', + }, + { + text: 'Getting Started', + link: '/guide/', + }, + ], + }, + { + text: 'API', + children: apiPages, + }, + { + text: 'Migrating from Faker v5', + link: '/migration-guide-v5/', + }, + ], +}; + +const algolia: DefaultTheme.AlgoliaSearchOptions = { + apiKey: process.env.API_KEY, + appId: process.env.APP_ID, + indexName: 'fakerjs', +}; + +const description = + 'Generate massive amounts of fake (but reasonable) data for testing and development.'; +const image = 'https://fakerjs.dev/social-image.png'; + +export default defineConfig({ + title: 'Faker', + description, + head: [ + ['link', { rel: 'icon', href: '/logo.svg' }], + ['meta', { name: 'theme-color', content: '#40af7c' }], + [ + 'meta', + { + name: 'og:description', + content: description, + }, + ], + [ + 'meta', + { + name: 'twitter:description', + content: description, + }, + ], + [ + 'meta', + { + name: 'description', + content: description, + }, + ], + [ + 'meta', + { + name: 'og:image', + content: image, + }, + ], + [ + 'meta', + { + name: 'twitter:image', + content: image, + }, + ], + [ + 'meta', + { + name: 'twitter:card', + content: 'summary_large_image', + }, + ], + ], + themeConfig: { + repo: 'faker-js/faker', + logo: '/logo.svg', + docsDir: 'docs', + docsBranch: 'main', + editLinks: true, + editLinkText: 'Suggest changes to this page', + nav, + sidebar, + algolia, + }, +}); diff --git a/docs/.vitepress/theme/components/index.mjs b/docs/.vitepress/theme/components/index.mjs deleted file mode 100644 index 4b77998a..00000000 --- a/docs/.vitepress/theme/components/index.mjs +++ /dev/null @@ -1,7 +0,0 @@ -import Badge from './Badge.vue'; -import Playground from './Playground.vue'; - -export default { - Playground, - Badge, -}; diff --git a/docs/.vitepress/theme/components/index.ts b/docs/.vitepress/theme/components/index.ts new file mode 100644 index 00000000..4b77998a --- /dev/null +++ b/docs/.vitepress/theme/components/index.ts @@ -0,0 +1,7 @@ +import Badge from './Badge.vue'; +import Playground from './Playground.vue'; + +export default { + Playground, + Badge, +}; 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.mjs deleted file mode 100644 index e4f3534f..00000000 --- a/docs/.vitepress/theme/index.mjs +++ /dev/null @@ -1,12 +0,0 @@ -import DefaultTheme from 'vitepress/theme'; -import GlobalComponents from './components'; -import './index.css'; - -export default { - ...DefaultTheme, - enhanceApp({ app }) { - for (const [name, component] of Object.entries(GlobalComponents)) { - app.component(name, component); - } - }, -}; diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts new file mode 100644 index 00000000..e4f3534f --- /dev/null +++ b/docs/.vitepress/theme/index.ts @@ -0,0 +1,12 @@ +import DefaultTheme from 'vitepress/theme'; +import GlobalComponents from './components'; +import './index.css'; + +export default { + ...DefaultTheme, + enhanceApp({ app }) { + for (const [name, component] of Object.entries(GlobalComponents)) { + app.component(name, component); + } + }, +}; -- cgit v1.2.3