Skip to content

Latest commit

 

History

History
68 lines (51 loc) · 1.98 KB

README.md

File metadata and controls

68 lines (51 loc) · 1.98 KB

Functions

parseVueDocs(directory)Promise.<Array.<VueComponent>>

Deeply scans given directory looking for .vue files.

Typedefs

CategoryMeta : Object

Metadata of a category

VueComponent : Object

parseVueDocs(directory) ⇒ Promise.<Array.<VueComponent>>

Deeply scans given directory looking for .vue files.

Kind: global function
Returns: Promise.<Array.<VueComponent>> - Array of VueComponent's

Param Type Description
directory String Directory to components

CategoryMeta : Object

Metadata of a category

Kind: global typedef
Properties

Name Type Description
icon String | null Icon of the component. See Font Awesome.
name String Full name of the category. Defaults to the result of analyzing the anatomy of the directory structure. i.e. /components/:category/component.vue

Example
From /:category/meta.json

{
  "name": "The category name",
  "icon": "apple"
}

VueComponent : Object

Kind: global typedef
Properties

Name Type Description
filePath String Absolute path to the component
name String The tag name of the component (i.e. <component-name/>)
category Array.<CategoryMeta> Category of the component
docs String Markdown docs of the component

© 2019 Martin Rafael [email protected]