vue-doxen

vue-doxen

The world's best Vue.js component documentation tool!

• Designed specifically to work with Vue 3 components (exclusively)
• Fully customizable
• All CSS is optional
• Documentation lives in the component as code (or in separate object if preferred)
• Vue-Doxen is just a Vue component, so it works anywhere a Vue component would work.
• Generates at runtime, so always up-to-date
• Doesn't require adopting an entire ecosystem or installing tons of dependencies, just use what works with Vue and you're good.

Using the library

Go to the docs site for usage and installation steps:

• https://TheJaredWilcurt.com/vue-doxen

Running this repo locally to make PRs

1. Uninstall Node/npm/nvm/nvm-windows/n/nodist/volta
2. Install Proto
3. Clone the repo
4. npm install
5. npm run build builds both the docs site and library
6. npm run lint checks for linting errors

Project Structure

• Documentation site
  • npm start will launch the app for local development
  • Code lives in app folder
  • Uses vite.config.docs.js
  • npm run build will produce docs folder
• Library
  • To manually test/develop the library use the docs site via npm start
  • Code lives in the lib folder
  • Uses vite.config.lib.js
  • npm run build will produce dist folder
  • npm t runs unit tests for the library
• DoxenLinter
  • All linter related code exists int he /lib/linter folder.
  • Tests for the linter run via npm t
  • The doxenLinter function is an export of the library and included in the main build (npm run build)