docs: automatically generate api docs from source (faker-js#289)

Co-authored-by: Shinigami <[email protected]>

Author: 2 people

.gitignore

@@ -72,6 +72,7 @@ versions.json
 # Dist
 /dist
 /docs/.vitepress/dist
+/docs/api/typedoc.json
 /lib
 
 # Faker

docs/.vitepress/.gitignore

@@ -0,0 +1 @@
+api-pages.mjs

docs/.vitepress/config.mjs

@@ -1,4 +1,5 @@
 import { defineConfig } from 'vitepress';
+import { apiPages } from './api-pages.mjs';
 
 const nav = [
   { text: 'Guide', link: '/guide/' },
@@ -22,61 +23,7 @@ const sidebar = {
     },
     {
       text: 'API',
-      children: [
-        {
-          text: 'Address',
-          link: '/api/address',
-          collapsable: false, // optional, defaults to true
-        },
-        {
-          text: 'Commerce',
-          link: '/api/commerce',
-        },
-        {
-          text: 'Company',
-          link: '/api/company',
-        },
-        {
-          text: 'Database',
-          link: '/api/database',
-        },
-        {
-          text: 'Datatype',
-          link: '/api/datatype',
-        },
-        {
-          text: 'Date',
-          link: '/api/date',
-        },
-        {
-          text: 'Fake',
-          link: '/api/fake',
-        },
-        {
-          text: 'Finance',
-          link: '/api/finance',
-        },
-        {
-          text: 'Hacker',
-          link: '/api/hacker',
-        },
-        {
-          text: 'Helpers',
-          link: '/api/helpers',
-        },
-        {
-          text: 'Image',
-          link: '/api/image',
-        },
-        {
-          text: 'Internet',
-          link: '/api/internet',
-        },
-        {
-          text: 'Localization',
-          link: '/api/localization',
-        },
-      ],
+      children: apiPages,
     },
     {
       text: 'Migrating from Faker v5',

docs/api/.gitignore

@@ -0,0 +1,3 @@
+*.md
+!fake.md
+!localization.md