Example usage #10
Closed
Gugustinette
started this conversation in
Show and tell
Example usage
#10
Replies: 6 comments 23 replies
-
|
Hi, are you using the latest version of the plugin? If not, update it, because I am currently working very actively on improving In the latest version, the description is preceded by Update the plugin version and show what it generates for you, then we'll see what the current problems are and I'll fix them Don't forget to keep updating for the latest fixes and features |
Beta Was this translation helpful? Give feedback.
0 replies
-
|
@Gugustinette Try to build documentation without my plugin settings, if the generated |
Beta Was this translation helpful? Give feedback.
0 replies
-
|
Works great so far ! Main thing I miss I think is the parsing of descriptions for TOC, similar to this commit that does it for titles. |
Beta Was this translation helpful? Give feedback.
0 replies
-
|
Also, I don't know how reliable LLMs will be able to crawl the website, but maybe having an option to write TOC links as full URL, instead of relative path would be better ? |
Beta Was this translation helpful? Give feedback.
6 replies
-
|
@Gugustinette A new You can now attach a domain to links: llmstxt({ domain: 'https://example.com' }) |
Beta Was this translation helpful? Give feedback.
-
|
I'll release it in a bit UPD: Released - https://github.com/okineadev/vitepress-plugin-llms/releases/tag/v0.0.17 |
Beta Was this translation helpful? Give feedback.
-
|
@okineadev I updated to v0.0.17, and now the TOC is empty 🧐 
I did not change my config : import { defineConfig } from 'vitepress'
import llmstxt from 'vitepress-plugin-llms'
export default defineConfig({
...
vite: {
plugins: [llmstxt({
customTemplateVariables: {
title: 'Fibbo',
description: 'Fibbo is a web-based game engine, built on top of Three.js, Rapier and PixiJS. It offers a unified object-oriented API and modern web-like DX in the context of making games.',
},
})],
})Did something break ? Or am I missing a required change to my config ? |
Beta Was this translation helpful? Give feedback.
-
|
Fixed in |
Beta Was this translation helpful? Give feedback.
-
|
Updated and it works like a charm ! Thanks for being so reactive 👍 |
Beta Was this translation helpful? Give feedback.
-
|
@Gugustinette In version If you notice any bugs or have suggestions for improvement - let me know in issues |
Beta Was this translation helpful? Give feedback.
14 replies
-
|
Thanks ! Also, could the description for each link be parsed from the file content ? (probably using the first So descriptions could be added like in the Nuxt one : That would clearly be useful for LLM's context. |
Beta Was this translation helpful? Give feedback.
-
Currently it parses the description from the key Regarding |
Beta Was this translation helpful? Give feedback.
-
I fixed it in 17e73ba, try this version: npm i https://pkg.pr.new/vitepress-plugin-llms@17e73ba --save-dev |
Beta Was this translation helpful? Give feedback.
-
|
17e73ba fixed it ! You can release this I think 👍 |
Beta Was this translation helpful? Give feedback.
-
ok |
Beta Was this translation helpful? Give feedback.
-
|
@okineadev Is that how I should configure my markdown file so the description will be displayed in ---
description: "Want to create a new game ? Fibbo provides a starter project based on [Vite](https://vitejs.dev/) for both 2D and 3D games. It includes a basic scene as well as devtools to help you get started quickly."
---
# Installation
Want to create a new game ? Fibbo provides a starter project based on [Vite](https://vitejs.dev/) for both 2D and 3D games. It includes a basic scene as well as devtools to help you get started quickly.
... |
Beta Was this translation helpful? Give feedback.
3 replies
-
|
Yes, I'll fix it now. |
Beta Was this translation helpful? Give feedback.
-
|
Fixed in 2732122 |
Beta Was this translation helpful? Give feedback.
-
|
Yes it works now ! Awesome ! |
Beta Was this translation helpful? Give feedback.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Just configured your plugin for my web-based game engine : https://fibbo.dev/
It works like a charm :
I used T3 Chat to test usage with Search option before and after, this clearly is a game changer.
Only thing I could say is that I would like to have such a clean llms.txt file if possible : https://nuxt.com/llms.txt
Being able to edit title and description with options in the config would be a great start I guess.
Also, for each file, being able to :
Reading where they are in the sidebar could also be a good way of doing it.
>?Beta Was this translation helpful? Give feedback.
All reactions