Skip to content

docs: automatically generate api docs from source #289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Jan 27, 2022
Merged
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ versions.json
# Dist
/dist
/docs/.vitepress/dist
/docs/api/typedoc.json
/lib

# Faker
Expand Down
1 change: 1 addition & 0 deletions docs/.vitepress/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
api-pages.mjs
57 changes: 2 additions & 55 deletions docs/.vitepress/config.mjs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { defineConfig } from 'vitepress';
import { apiPages } from './api-pages.mjs';

const nav = [
{ text: 'Guide', link: '/guide/' },
Expand All @@ -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,
},
],
};
Expand Down
3 changes: 3 additions & 0 deletions docs/api/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*.md
!fake.md
!localization.md
181 changes: 0 additions & 181 deletions docs/api/address.md

This file was deleted.

62 changes: 0 additions & 62 deletions docs/api/commerce.md

This file was deleted.

Loading