Skip to content
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

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

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

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 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
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 .prettierrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"tabWidth": 4,
"semi": false,
"useTabs": true,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, noimage

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But in the configuration file of Vitepress the tabs are used

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

,,

"trailingComma": "none",
"singleQuote": true
}
4 changes: 2 additions & 2 deletions bun.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
"view-transitions-api-types": "^0.1.1",
"vite-plugin-node-polyfills": "^0.23.0",
"vitepress": "^1.6.3",
"vitepress-plugin-llms": "^0.0.16",
"vitepress-plugin-llms": "^0.0.17",
"vue": "^3.5.13",
},
},
Expand Down Expand Up @@ -1704,7 +1704,7 @@

"vitepress": ["[email protected]", "", { "dependencies": { "@docsearch/css": "3.8.2", "@docsearch/js": "3.8.2", "@iconify-json/simple-icons": "^1.2.21", "@shikijs/core": "^2.1.0", "@shikijs/transformers": "^2.1.0", "@shikijs/types": "^2.1.0", "@types/markdown-it": "^14.1.2", "@vitejs/plugin-vue": "^5.2.1", "@vue/devtools-api": "^7.7.0", "@vue/shared": "^3.5.13", "@vueuse/core": "^12.4.0", "@vueuse/integrations": "^12.4.0", "focus-trap": "^7.6.4", "mark.js": "8.11.1", "minisearch": "^7.1.1", "shiki": "^2.1.0", "vite": "^5.4.14", "vue": "^3.5.13" }, "peerDependencies": { "markdown-it-mathjax3": "^4", "postcss": "^8" }, "optionalPeers": ["markdown-it-mathjax3", "postcss"], "bin": { "vitepress": "bin/vitepress.js" } }, "sha512-fCkfdOk8yRZT8GD9BFqusW3+GggWYZ/rYncOfmgcDtP3ualNHCAg+Robxp2/6xfH1WwPHtGpPwv7mbA3qomtBw=="],

"vitepress-plugin-llms": ["[email protected].16", "", { "dependencies": { "gray-matter": "^4.0.3", "markdown-title": "^1.0.2", "minimatch": "^10.0.1", "picocolors": "^1.1.1", "string-strip-html": "^13.4.12" } }, "sha512-wtA8EhtXELhrwmSxgDuj3nX0iCL99igffFJsj8T1Mb98RsqZl1rYdy5PNFpF3jfjP96xAwT+q9LjfRYvtoLIuA=="],
"vitepress-plugin-llms": ["[email protected].17", "", { "dependencies": { "gray-matter": "^4.0.3", "markdown-title": "^1.0.2", "minimatch": "^10.0.1", "picocolors": "^1.1.1", "string-strip-html": "^13.4.12" } }, "sha512-h297CXsx/AmiuGfsaCCqBsqebISgAsQKlZU88tPKuOL8F+dkH2GuYW6SI3nDoC2rv2Eq/A+z5noIoM2WiNEb6Q=="],

"vm-browserify": ["[email protected]", "", {}, "sha512-2ham8XPWTONajOR0ohOKOHXkm3+gaBmGut3SRuu75xLd/RRaY6vqgh8NBYYk7+RW3u5AtzPQZG8F10LHkl0lAQ=="],

Expand Down
8 changes: 6 additions & 2 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 {
Expand Down Expand Up @@ -44,7 +43,12 @@ export default defineConfig({
},
plugins: [
tailwindcss() as any,
llmstxt()
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({
// // Fill in your repository URL here
// repoURL: () => 'https://github.com/elysiajs/documentation'
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
"view-transitions-api-types": "^0.1.1",
"vite-plugin-node-polyfills": "^0.23.0",
"vitepress": "^1.6.3",
"vitepress-plugin-llms": "^0.0.16",
"vitepress-plugin-llms": "^0.0.17",
"vue": "^3.5.13"
},
"scripts": {
Expand Down