Auto-generate Vue.js component documentation, store reference, and project setup guides. Works with Vue 2 and Vue 3, Options API and Composition API.
Vue component libraries in particular suffer from undocumented props and emit events. A component that accepts 12 props with no documentation becomes a frustrating black box for every developer who tries to use it.
Tailored documentation features for Vue codebases
Documents Vue SFC props, emits, slots, and expose() using both Options and Composition API patterns
Generates Pinia store reference with state shape, actions, and getters documented
Documents Vue Router configuration — routes, guards, and meta fields
Detects Vue 2 vs Vue 3 and generates correct API reference for the version in use
From zero to published docs in under a minute
Paste your GitHub repository URL. Public repos work instantly — no signup required for the free README preview.
Codec8 reads your Vue source code, dependencies, and structure, then generates README, API docs, architecture diagrams, and setup guide.
Download your documentation as Markdown files or let Codec8 open a pull request directly to your repository.
These well-known projects are perfect candidates for Codec8
Yes. Codec8 fully supports Vue 2 projects including Options API components, Vuex stores, and Vue Router 3. It generates documentation appropriate for Vue 2 consumers.
Yes. Codec8 generates a complete component API reference suitable for your library's documentation site, including installation, registration, and per-component usage examples.
Codec8 fully parses <script setup> syntax including defineProps, defineEmits, defineExpose, and the new defineModel macro, generating complete component API documentation.
Paste your GitHub repo URL and get a free README preview in 60 seconds. No signup required.
Generate Vue docs free