Eyelash
Vue Atomic Docs Project

Vue Atomic Docs

Vue Atomic Docs transforms your Vue components into a living, interactive documentation library that runs alongside your application without bloating your production bundle. It automatically extracts component props and provides an intuitive interface for showcasing real-world usage examplesβ€”keeping your component documentation always in sync with your actual code while events and slots can be easily defined through a simple API.

  • ⚑ Automatic Prop & Type Tables - Extracts and displays component props with types
  • πŸ› οΈ Interactive Component Playground - Test components with different prop values
  • πŸ—‚οΈ Source Code Viewer (<template>, <script>, <style>) - View component source code
  • 🎨 Design System Color Palette - Display and document your brand colors
  • πŸ” Component Search - Quickly find components in your documentation
  • πŸŒ™ Light/Dark Mode - Toggle between light and dark themes
  • πŸ“ Typography Documentation - Document and display your typography styles
  • πŸ”Œ Custom Documentation Pages - Add custom routes and pages to your docs
  • πŸ“„ Markdown Support - Write documentation using Markdown

Documentation and demo site Vue Atomic Docs.

Check out the source code on GitHub.