diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 723737b..6a1502a 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -35,6 +35,7 @@ export default withMermaid({ nav: [ { text: 'Guide', link: '/guide/introduction', activeMatch: '/guide' }, { text: 'API', link: '/api', activeMatch: '/api' }, + { text: 'LLMs', link: '/llms', activeMatch: '/llms' }, { text: 'Examples', link: '/examples', activeMatch: '/examples' }, { text: 'Sponsors', link: '/#sponsors', activeMatch: '/#sponsors' }, { text: 'License', link: 'https://github.com/Vanilagy/mediabunny#license' }, @@ -121,7 +122,11 @@ export default withMermaid({ plugins: [ // eslint-disable-next-line @typescript-eslint/no-explicit-any tailwindcss() as any, - llmstxt(), + llmstxt({ + ignoreFiles: [ + 'api/*', + ], + }), ], }, outDir: '../dist-docs', diff --git a/docs/assets/mediarobot.svg b/docs/assets/mediarobot.svg new file mode 100644 index 0000000..a931796 --- /dev/null +++ b/docs/assets/mediarobot.svg @@ -0,0 +1,162 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/llms.md b/docs/llms.md new file mode 100644 index 0000000..630140c --- /dev/null +++ b/docs/llms.md @@ -0,0 +1,28 @@ +# Mediabunny and LLMs + +
+
+
+ +
+
+ +While Mediabunny is proudly human-coded, we want to encourage any and all usage of Mediabunny, even when the vibes are high. + +Mediabunny is still new and is unlikely to be in the training data of modern LLMs, but we can still make the AI perform extremely well but just giving it a little more context. + +--- + +Give one or more of these files to your LLM: + +### [mediabunny.d.ts](/mediabunny.d.ts) + +This file contains the entire public TypeScript API of Mediabunny and is commented extremely thoroughly. + +### [llms.txt](/llms.txt) + +This file provides an index of Mediabunny's guide, which the AI can then further dive into if it wants to. + +### [llms_full.txt](/llms-full.txt) + +This is just the entire Mediabunny guide in a single file. diff --git a/package.json b/package.json index e5ae439..dd572ba 100644 --- a/package.json +++ b/package.json @@ -33,7 +33,7 @@ "check": "tsc -p src --noEmit && tsc -p packages/mp3-encoder/src --noEmit && tsc -p scripts --noEmit && tsc -p tsconfig.vite.json --noEmit && rm tsconfig.vite.tsbuildinfo", "check-docblocks": "tsx scripts/check-docblocks.ts dist/mediabunny.d.ts", "docs:dev": "vitepress dev docs", - "docs:build": "npm run docs:generate && vitepress build docs && npm run examples:build", + "docs:build": "npm run build && npm run docs:generate && vitepress build docs && npm run examples:build && cp dist/mediabunny.d.ts dist-docs/", "docs:preview": "vitepress preview docs", "docs:generate": "tsx scripts/generate-api-docs.ts src/index.ts packages/mp3-encoder/src/index.ts docs/api-config.json", "dev": "vite",