exportdefaultfunctioncomponent(renderedUsage:RenderedUsage,// props, events, methods and slots documentation rendereddoc:ComponentDoc,// the object returned by vue-docgen-apiconfig:DocgenCLIConfig,// the local config, useful to know the contextfileName:string,// the name of the current file in the...
import{parse}from'vue-docgen-api'asyncfunctionparseMyComponent(filePath:string){varcomponentInfoSimple=awaitparse(filePath)varcomponentInfoConfigured=awaitparse(filePath,{alias:{'@assets':path.resolve(__dirname,'src/assets')},modules:[path.resolve(__dirname,'src')],addScriptHandlers:[function(document...
Created from react styleguidist for Vue Components with a living style guide - vue-docgen-api to parse type TSInstantiationExpression (#1533) · vue-styleguidist/vue-styleguidist@3d22684
First, install the loader and vue-docgen-api. $ yarn add -D vue-docgen-loader vue-docgen-api#or npm#$ npm i -D vue-docgen-loader vue-docgen-api Then add the loader to your webpack config file.Please make sure to run the loader at the last of the loader chain. ...
vue-docgen-api/dist/main.d.ts Version: 2.01 kBTypeScriptView Raw 1 import Documentation, { ComponentDoc, PropDescriptor, SlotDescriptor, EventDescriptor, MethodDescriptor, ExposeDescriptor, BlockTag, Param, Tag, ParamTag, ParamType } from './Documentation'; 2 import type { ParseOptions, DocG...
## Install Install the module directly from npm: ```sh npm install vue-docgen-api --save-dev ``` ## API The tool can be used programmatically to extract component information and customize the extraction process: ```js var vueDocs = require('vue-docgen-api')...
vue-docgen-api-bug 用CodeSandbox创建 (0)踩踩(0) 所需:1积分 anyRTC-Meeting-Android 2025-04-08 00:00:32 积分:1 职称评审管理系统 2025-04-08 00:10:36 积分:1 高校竞赛评审系统 2025-04-08 00:11:12 积分:1 script 2025-04-08 00:18:19 ...
*/include:/\.vue$/,/* Regex (optional) - The file path pattern to exclude */exclude:/\.story\.vue$/,/* String (optional) - The property name to inject the docgen metadata at */injectAt:'__docgenInfo'/* Object (optional) - Specific Docgen API options */docgenOptions:{jsx:true}}...
npm install vuepress-markdown-it-vue-docgen Usage Write your Vue component and add relevant comments In your config.js, useextendsMarkdown. you can customize the component path being used by setting the plugin's options: importpathfrom'path'importvueDocgenfrom'vuepress-markdown-it-vue-docgen'ext...
npm install vue-docgen-api --save-dev APIThe tool can be used programmatically to extract component information and customize the extraction process:var vueDocs = require('vue-docgen-api'); var componentInfo = vueDocs.parse(filePath);parse(filePath)...