{"id":50639354,"url":"https://github.com/smashedr/vitepress-chat","last_synced_at":"2026-06-07T07:01:16.755Z","repository":{"id":358782628,"uuid":"1243050089","full_name":"smashedr/vitepress-chat","owner":"smashedr","description":"VitePress AI Chat Plugin","archived":false,"fork":false,"pushed_at":"2026-06-06T06:47:13.000Z","size":261,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-06-06T08:13:33.117Z","etag":null,"topics":["vitepress-plugin"],"latest_commit_sha":null,"homepage":"https://smashedr.github.io/vitepress-chat/","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smashedr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"docs/support.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null},"funding":{"ko_fi":"cssnr"}},"created_at":"2026-05-19T02:18:59.000Z","updated_at":"2026-06-06T06:45:44.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/smashedr/vitepress-chat","commit_stats":null,"previous_names":["smashedr/vitepress-chat"],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/smashedr/vitepress-chat","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smashedr%2Fvitepress-chat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smashedr%2Fvitepress-chat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smashedr%2Fvitepress-chat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smashedr%2Fvitepress-chat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smashedr","download_url":"https://codeload.github.com/smashedr/vitepress-chat/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smashedr%2Fvitepress-chat/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34011812,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-07T02:00:07.652Z","response_time":124,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["vitepress-plugin"],"created_at":"2026-06-07T07:01:15.820Z","updated_at":"2026-06-07T07:01:16.748Z","avatar_url":"https://github.com/smashedr.png","language":"Vue","funding_links":["https://ko-fi.com/cssnr"],"categories":[],"sub_categories":[],"readme":"[![GitHub Release Version](https://img.shields.io/github/v/release/smashedr/vitepress-chat?logo=github)](https://github.com/smashedr/vitepress-chat/releases/latest)\n[![Deployment Docs](https://img.shields.io/github/deployments/smashedr/vitepress-chat/docs?logo=vitepress\u0026logoColor=white\u0026label=docs)](https://github.com/smashedr/vitepress-chat/deployments/docs)\n[![Deployment Preview](https://img.shields.io/github/deployments/smashedr/vitepress-chat/preview?logo=docker\u0026logoColor=white\u0026label=preview)](https://github.com/smashedr/vitepress-chat/deployments/preview)\n[![Workflow Release](https://img.shields.io/github/actions/workflow/status/smashedr/vitepress-chat/release.yaml?logo=norton\u0026logoColor=white\u0026label=release)](https://github.com/smashedr/vitepress-chat/actions/workflows/release.yaml)\n[![Workflow Lint](https://img.shields.io/github/actions/workflow/status/smashedr/vitepress-chat/lint.yaml?logo=norton\u0026logoColor=white\u0026label=lint)](https://github.com/smashedr/vitepress-chat/actions/workflows/lint.yaml)\n[![GitHub Last Commit](https://img.shields.io/github/last-commit/smashedr/vitepress-chat?logo=listenhub\u0026label=updated)](https://github.com/smashedr/vitepress-chat/pulse)\n[![GitHub Repo Size](https://img.shields.io/github/repo-size/smashedr/vitepress-chat?logo=buffer\u0026label=repo%20size)](https://github.com/smashedr/vitepress-chat?tab=readme-ov-file#readme)\n[![GitHub Top Language](https://img.shields.io/github/languages/top/smashedr/vitepress-chat?logo=devbox)](https://github.com/smashedr/vitepress-chat?tab=readme-ov-file#readme)\n[![GitHub Contributors](https://img.shields.io/github/contributors-anon/smashedr/vitepress-chat?logo=southwestairlines)](https://github.com/smashedr/vitepress-chat/graphs/contributors)\n[![GitHub Issues](https://img.shields.io/github/issues/smashedr/vitepress-chat?logo=codeforces\u0026logoColor=white)](https://github.com/smashedr/vitepress-chat/issues)\n[![GitHub Discussions](https://img.shields.io/github/discussions/smashedr/vitepress-chat?logo=theconversation)](https://github.com/smashedr/vitepress-chat/discussions)\n[![GitHub Forks](https://img.shields.io/github/forks/smashedr/vitepress-chat?style=flat\u0026logo=forgejo\u0026logoColor=white)](https://github.com/smashedr/vitepress-chat/forks)\n[![GitHub Repo Stars](https://img.shields.io/github/stars/smashedr/vitepress-chat?style=flat\u0026logo=gleam\u0026logoColor=white)](https://github.com/smashedr/vitepress-chat/stargazers)\n[![GitHub Org Stars](https://img.shields.io/github/stars/cssnr?style=flat\u0026logo=apachespark\u0026logoColor=white\u0026label=org%20stars)](https://cssnr.github.io/)\n[![Discord](https://img.shields.io/discord/899171661457293343?logo=discord\u0026logoColor=white\u0026label=discord\u0026color=7289da)](https://discord.gg/wXy6m2X8wY)\n[![Ko-fi](https://img.shields.io/badge/Ko--fi-72a5f2?logo=kofi\u0026label=support)](https://ko-fi.com/cssnr)\n\n# VitePress Chat\n\n\u003ca title=\"VitePress Chat Plugin\" href=\"https://smashedr.github.io/vitepress-chat/\" target=\"_blank\"\u003e\n\u003cimg alt=\"VitePress Chat Plugin\" align=\"right\" width=\"128\" height=\"auto\" src=\"https://raw.githubusercontent.com/smashedr/vitepress-chat/refs/heads/master/docs/public/images/logo.svg\"\u003e\u003c/a\u003e\n\n- [Install](#Install)\n- [Setup](#Setup)\n- [Server](#Server)\n- [Development](#Development)\n- [Support](#Support)\n- [Contributing](#Contributing)\n\nA VitePress Chat Plugin providing AI Chat support trained on your docs.\nIncludes instructions generator plugin, or works with your existing plugin.\nSecurely connect to any AI provider you choose via the [ai-chat-server](https://github.com/smashedr/ai-chat-server) proxy.\n\n💯 100% Free to use with Zen OpenCode or Gemini Free Tier!\n\n🔒 The [server](https://github.com/smashedr/ai-chat-server) features live-streaming results, input token caching, retry on failure and much more.\nWorks with Claude, Gemini, OpenAI, or any [OpenAI Compatible Provider](https://ai-sdk.dev/providers/openai-compatible-providers).\n\n[![View Live Demo](https://img.shields.io/badge/view_live_demo-green?style=for-the-badge\u0026logo=chatbot\u0026logoColor=white)](https://smashedr.github.io/vitepress-chat/)\n\n- Client: https://github.com/smashedr/vitepress-chat\n- Server: https://github.com/smashedr/ai-chat-server\n\n### Features\n\n- Set Custom Button And Header Text and Link\n- Includes Instructions Generation Plugin\n- Set Custom File Name and Exclude Globs\n- Works with Existing LLM Generation Plugins\n- Plus all the [Server Features](https://github.com/smashedr/ai-chat-server?tab=readme-ov-file#features)\n\nBuilt with the [AI SDK](https://ai-sdk.dev/).\n\n## Install\n\nUsing your favorite package manager...\n\n```shell\nnpm install github:smashedr/vitepress-chat\n```\n\nInstall a [tagged release](https://github.com/smashedr/vitepress-chat/releases) or hash.\n\n```shell\nnpm install github:smashedr/vitepress-chat#0.1.2\n```\n\nUpdate after installing.\n\n```shell\nnpm update @cssnr/vitepress-chat\n```\n\n[![View Documentation](https://img.shields.io/badge/view_documentation-blue?style=for-the-badge\u0026logo=googledocs\u0026logoColor=white)](https://smashedr.github.io/vitepress-chat/)\n\n## Setup\n\nThere are two components, the [Chat Plugin](#chat-plugin) which adds the chat button and box.\nPlus the [Instructions Generator](#instructions-generator) plugin which generates instructions.txt file.\n\nThis allows you to use this with other instructions generator plugins or existing `llms.txt` files.\n\n### Chat Plugin\n\nAdd the plugin to your theme.\n\n- `.vitepress/theme/index.[js,ts]`.\n\nUsing the default theme.\n\n```typescript\nimport DefaultTheme from 'vitepress/theme'\n\nimport chat from '@cssnr/vitepress-chat'\nimport '@cssnr/vitepress-chat/style.css'\n\n// https://vitepress.dev/guide/extending-default-theme\nexport default {\n  ...DefaultTheme,\n  ...chat(DefaultTheme, {\n    api: 'https://ai-chat-server.cssnr.com/',\n    headers: { Authorization: 'Basic Abc123=' },\n  }),\n}\n```\n\nUsing a [custom layout](https://vitepress.dev/guide/extending-default-theme#layout-slots).\n\n```typescript\nimport DefaultTheme from 'vitepress/theme'\nimport MyLayout from './MyLayout.vue'\n\nimport chat from '@cssnr/vitepress-chat'\nimport '@cssnr/vitepress-chat/style.css'\n\nexport default {\n  ...DefaultTheme,\n  ...chat(MyLayout, {\n    api: 'https://ai-chat-server.cssnr.com/',\n  }),\n}\n```\n\nWith a custom file name to use with other generators like [vitepress-plugin-llms](https://github.com/okineadev/vitepress-plugin-llms).\n\n```typescript\nexport default {\n  ...chat(DefaultTheme, {\n    api: 'https://ai-chat-server.cssnr.com/',\n    filePath: 'llms-full.txt',\n  }),\n}\n```\n\nWith a remote URL path.\n\n```typescript\nexport default {\n  ...chat(DefaultTheme, {\n    api: 'https://ai-chat-server.cssnr.com/',\n    filePath: 'https://smashedr.github.io/vitepress-chat/llms.txt',\n  }),\n}\n```\n\nSee the [ChatOptions](https://github.com/smashedr/vitepress-chat/blob/master/src/index.ts#L6) for more details...\n\n### Instructions Generator\n\nAdd the instruction generator plugin to your config.\n\n- `.vitepress/config.[ts,mts]`\n\nThis generates the `instructiosn.txt` from your docs folder when you run dev or build.\n\n```typescript\nimport { defineConfig } from 'vitepress'\n\nimport instructions from '@cssnr/vitepress-chat/instructions'\n\n// https://vitepress.dev/reference/site-config\nexport default defineConfig({\n  vite: {\n    plugins: [instructions()],\n  },\n})\n```\n\nTo exclude files/folders from the instructions use the exclude globs.\n\n```typescript\nexport default defineConfig({\n  vite: {\n    plugins: [instructions({ exclude: ['index.md', 'include/**/*'] })],\n  },\n})\n```\n\nSee the [InstructionsOptions](https://github.com/smashedr/vitepress-chat/blob/master/src/instructions.ts#L8) for more details...\n\n## Server\n\nFor server set instructions see:\n\n- Documentation: \u003chttps://smashedr.github.io/vitepress-chat/server\u003e\n- GitHub Repository: \u003chttps://github.com/smashedr/ai-chat-server\u003e\n\n[![Deploy to Render](https://img.shields.io/badge/Deploy_to_Render-4351E8?style=for-the-badge\u0026logo=render)](https://render.com/deploy?repo=https://github.com/smashedr/ai-chat-server)\n\n## Development\n\nThe docs run the plugin from source.\n\nCreate a `.env.development` file similar to this.\n\n```text\nVITE_AI_AUTH=Basic Abc123=\nVITE_AI_API=http://localhost:3000/\nVITE_AI_DEV_INSTRUCTIONS=You are a helpful assistant testing a chat box on a website and should respond with text/links in the requested length and formatting.\n```\n\nNote the `VITE_AI_DEV_INSTRUCTIONS` will replace the generated `instructions.txt` for development.\n\nThen run the docs to test your changes.\n\n```shell\nnpm i\nnpm run docs\n```\n\n## Support\n\nIf you run into any issues or need help getting started, please do one of the following:\n\n- Report an Issue: \u003chttps://github.com/smashedr/ai-chat-server/issues\u003e\n- Q\u0026A Discussion: \u003chttps://github.com/smashedr/ai-chat-server/discussions/categories/q-a\u003e\n- Request a Feature: \u003chttps://github.com/smashedr/ai-chat-server/issues/new?template=1-feature.yaml\u003e\n- Chat with us on Discord: \u003chttps://discord.gg/wXy6m2X8wY\u003e\n\n[![Features](https://img.shields.io/badge/features-brightgreen?style=for-the-badge\u0026logo=rocket\u0026logoColor=white)](https://github.com/smashedr/ai-chat-server/issues/new?template=1-feature.yaml)\n[![Issues](https://img.shields.io/badge/issues-red?style=for-the-badge\u0026logo=southwestairlines\u0026logoColor=white)](https://github.com/smashedr/ai-chat-server/issues)\n[![Discussions](https://img.shields.io/badge/discussions-blue?style=for-the-badge\u0026logo=livechat\u0026logoColor=white)](https://github.com/smashedr/ai-chat-server/discussions)\n[![Discord](https://img.shields.io/badge/discord-5865F2?style=for-the-badge\u0026logo=discord\u0026logoColor=white)](https://discord.gg/wXy6m2X8wY)\n\n## Contributing\n\nPlease consider making a donation to support the development of this project\nand [additional](https://cssnr.com/) open source projects.\n\n[![Ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/cssnr)\n\nFor a full list of current projects visit: [https://cssnr.github.io/](https://cssnr.github.io/)\n\n\u003ca href=\"https://github.com/smashedr/ai-chat-server/stargazers\"\u003e\n \u003cpicture\u003e\n   \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://api.star-history.com/svg?repos=smashedr/ai-chat-server\u0026type=date\u0026legend=bottom-right\u0026theme=dark\" /\u003e\n   \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://api.star-history.com/svg?repos=smashedr/ai-chat-server\u0026type=date\u0026legend=bottom-right\" /\u003e\n   \u003cimg alt=\"Star History Chart\" src=\"https://api.star-history.com/svg?repos=smashedr/ai-chat-server\u0026type=date\u0026legend=bottom-right\" /\u003e\n \u003c/picture\u003e\n\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmashedr%2Fvitepress-chat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmashedr%2Fvitepress-chat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmashedr%2Fvitepress-chat/lists"}