Vue-Happy-Little-Docs

Vue3 documentation generator only Vue3 script setup tag.

Installation

First, install Yeoman and vue-happy-little-docs using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g vue-happy-little-doc

Config

Create a file named hld-config.json in the directory where you want to generate the documentation. If you don't specify 'hld-config.json`, all files in the directory will be added to the documentation.

{
    "title": "Projekt name",
    "path": {
        "pages": "Relative path to pages dir",
        "stores": "Relative path to stores dir",
        "components": "Relative path to components dir"
    }
}

Create a documentation

yo vue-happy-little-doc build

then go to directory happy-little-docs and open index.html in a webbrowser