Skip to content

zuck/vuelentino

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

vuelentino

Generate docs for Vue components with style

Installation

npm install -g vuelentino

Getting started

# Look for Vue components and generate docs!
vuelentino

Vuelentino by default will look for Vue components using the src/**/*.vue glob pattern and will generate the documentation under docs/ using a Markdown template.

Of course, you can override all default options according to your needs:

vuelentino -i src/components/*.vue -o docs/components -t template.html

CLI options

Option Description Default
-i A glob pattern used to select the input files src/**/*.vue
-o A destination path for the generated docs docs/
-t The template used to render the docs Markdown template

Contribute

If you want, you can also freely donate to fund the project development:

Donate

Have you found a bug?

Please open a new issue on:

https://github.com/zuck/vuelentino/issues

License

Copyright (c) Emanuele Bertoldi

MIT License

About

Generate docs for Vue components with style

Resources

License

Stars

Watchers

Forks

Packages

No packages published