AI Documentation for Vue Projects
Hosted docs for Vue.js repos. Auto-generated, auto-updated nightly. Detects Composition API, Pinia stores, and Nuxt config.
Free for public repos. No account needed.
What ReadmeBot detects in your project
ReadmeBot analyses your repository and automatically identifies key configuration files and project structure. Here are the files and patterns it looks for:
vite.config.ts (vue plugin)src/App.vuenuxt.config.tssrc/stores/
What's included in your documentation
Based on what ReadmeBot finds in your repository, it generates structured documentation with the following sections tailored to your stack:
Installation and setup
Project structure
Components overview
State management (Pinia)
Testing with Vitest
Frequently asked questions
Does it support both Vue 2 and Vue 3?
Yes. ReadmeBot detects which Vue version your project uses and generates documentation matching the correct API style (Options vs Composition).
Will it detect Nuxt projects?
ReadmeBot recognises Nuxt configuration and documents Nuxt-specific features like auto-imports, layouts, and server routes.
Does it document Pinia stores?
If your project uses Pinia, ReadmeBot includes state management documentation with store descriptions.