Skip to content

chore(docs): improve vitepress-plugin-llms configuration #505

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.

Sign up for GitHub

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

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

chore(docs): improve vitepress-plugin-llms configuration #505

Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
bb6d757
feat(docs): generate `llms.txt` and `llms-full.txt`
okineadev Mar 28, 2025
7a853ae
dont ignore blog
okineadev Mar 28, 2025
9941441
Merge branch 'main' into llmstxt
okineadev Mar 28, 2025
0716829
fix whitespaces
okineadev Mar 28, 2025
4dc1490
update plugin configuration
okineadev Mar 29, 2025
9fb56d7
fix
okineadev Mar 29, 2025
ed3f151
Merge branch 'main' into llmstxt
okineadev Apr 7, 2025
9861b61
update plugin
okineadev Apr 7, 2025
91669d3
update plugin again
okineadev Apr 7, 2025
cf58a78
Merge branch 'main' into llmstxt
okineadev Apr 11, 2025
1b90710
Discard changes to .prettierrc
okineadev Apr 11, 2025
0e90c08
remove comment
okineadev Apr 11, 2025
912f382
Discard changes to bun.lock
okineadev Apr 11, 2025
6b61116
Merge branch 'main' into llmstxt
okineadev Apr 20, 2025
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
78 changes: 41 additions & 37 deletions docs/.vitepress/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import { transformerTwoslash } from '@shikijs/vitepress-twoslash'
import { createFileSystemTypesCache } from '@shikijs/vitepress-twoslash/cache-fs'

import tailwindcss from '@tailwindcss/vite'

import llmstxt from 'vitepress-plugin-llms'
import { analyzer } from 'vite-bundle-analyzer'

Expand Down Expand Up @@ -60,42 +59,47 @@ export default defineConfig({
},
plugins: [
tailwindcss() as any,
process.env.NODE_ENV === 'production' ? llmstxt() : [],
process.env.ANALYZE === 'true' ? analyzer() : [],
// GitChangelog({
// repoURL: () => 'https://github.com/elysiajs/documentation',
// mapAuthors: [
// {
// mapByEmailAliases: ['[email protected]'],
// avatar: '/blog/authors/aris.webp',
// links: [
// {
// type: 'GitHub',
// link: 'https://github.com/SaltyAom'
// }
// ]
// },
// {
// mapByNameAliases: ['bogeychan'],
// links: [
// {
// type: 'GitHub',
// link: 'http://github.com/bogeychan'
// }
// ]
// },
// {
// mapByNameAliases: ['Fecony'],
// links: [
// {
// type: 'GitHub',
// link: 'https://github.com/fecony'
// }
// ]
// }
// ]
// }),
// GitChangelogMarkdownSection()
process.env.NODE_ENV === 'production' ? llmstxt({
description: 'Ergonomic Framework for Humans',
details:
"Elysia is an ergonomic framework for Humans. With end-to-end type safety and great developer experience. Elysia is familiar, fast, and first class TypeScript support with well-thought integration between services whether it's tRPC, Swagger or WebSocket.",
ignoreFiles: ['index.md', 'table-of-content.md']
}) : [],
GitChangelog({
repoURL: () => 'https://github.com/elysiajs/documentation',
mapAuthors: [
{
mapByEmailAliases: ['[email protected]'],
avatar: '/blog/authors/aris.webp',
links: [
{
type: 'GitHub',
link: 'https://github.com/SaltyAom'
}
]
},
{
mapByNameAliases: ['bogeychan'],
links: [
{
type: 'GitHub',
link: 'http://github.com/bogeychan'
}
]
},
{
mapByNameAliases: ['Fecony'],
links: [
{
type: 'GitHub',
link: 'https://github.com/fecony'
}
]
}
]
}),
GitChangelogMarkdownSection(),
process.env.ANALYZE === 'true' ? analyzer() : []
],
optimizeDeps: {
exclude: ['@nolebase/vitepress-plugin-inline-link-preview/client']
Expand Down