{"id":32095354,"url":"https://github.com/rywaroy/vtmd","last_synced_at":"2025-10-19T22:59:34.096Z","repository":{"id":34980535,"uuid":"192837721","full_name":"rywaroy/vtmd","owner":"rywaroy","description":":wrench: .vue文件 react自动生成说明文档工具","archived":false,"fork":false,"pushed_at":"2022-02-12T02:22:32.000Z","size":305,"stargazers_count":10,"open_issues_count":6,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-09-17T00:50:33.899Z","etag":null,"topics":["babel","markd","node","vuepress"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rywaroy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-20T02:52:27.000Z","updated_at":"2023-06-08T05:47:28.000Z","dependencies_parsed_at":"2022-08-08T03:15:30.011Z","dependency_job_id":null,"html_url":"https://github.com/rywaroy/vtmd","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rywaroy/vtmd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rywaroy%2Fvtmd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rywaroy%2Fvtmd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rywaroy%2Fvtmd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rywaroy%2Fvtmd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rywaroy","download_url":"https://codeload.github.com/rywaroy/vtmd/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rywaroy%2Fvtmd/sbom","scorecard":{"id":793267,"data":{"date":"2025-08-11","repo":{"name":"github.com/rywaroy/vtmd","commit":"f44c42bda0871129d21249220b996afd43b17b44"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":0,"reason":"26 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-6chw-6frg-f759","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-3gx7-xhv7-5mx3","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-6vfc-qv3f-vr6c","Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj","Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-mxhp-79qh-mcx6","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-cf4h-3jhx-xvhq","Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx","Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-23T08:11:12.476Z","repository_id":34980535,"created_at":"2025-08-23T08:11:12.476Z","updated_at":"2025-08-23T08:11:12.476Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279936344,"owners_count":26247091,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-19T02:00:07.647Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["babel","markd","node","vuepress"],"created_at":"2025-10-19T22:59:32.920Z","updated_at":"2025-10-19T22:59:34.089Z","avatar_url":"https://github.com/rywaroy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vtmd\n\n\u003e .vue文件 / umi 转化成说明文档，配合vuepress使用，因懒惰而进步！\n\n## 安装\n\n```\nnpm i vtmd -D\n```\n\n## 使用\n\n创建`vtmd.config.js`文件\n\n```js\nmodule.exports = {\n  entry: 'components',\n  compontent: true,\n  output: 'docs',\n};\n```\n\n执行命令\n\n```\nnpx vtmd --component --config vtmd.config.js\n```\n\n或者指定文件\n\n```\nnpx vtmd components/A components/B.vue\n```\n\n\u003e 文件后缀可不带.vue，会自动检测添加\n\n假如不配置config，会默认查找当前目录下的`vtmd.config.js`文件，没有该文件则会使用默认配置\n\n**配置参数说明**\n\n| 属性 | 类型 | 默认值 | 说明 |\n| --- | --- | --- | :--- |\n| entry | string | src | 入口文件夹，该文件夹内所有vue文件都将被执行转化 |\n| compontent | boolean | false | 是否使用vue组件 |\n| ignore | string、array | null | 需要忽略的文件夹 |\n| output | string | doc | 生成的目标文件夹 |\n| target | array | [] | 指定vue文件的路径 |\n\n配置了`compontent: true`可以使用vue组件来自定义样式。使用`--component`,默认的配置参数`compontent`会变成`true`，同时vtmd会在`docs/.vuepress/components`文件夹下生成vue组件：\n\n* `VtmdHead2.vue` - 改写 h2 组件\n\n* `VtmdHead3.vue` - 改写 h3 组件\n\n* `VtmdMethodName.vue` - methods、computed、filters、watch 方法名组件\n\n* `VtmdNotes.vue` - 注释组件\n\n* `VtmdProps.vue` - props data 的属性名组件\n\n* `VtmdBlock.vue` - 块组件\n\n* `VtmdFileBox.vue` - 文件容器组件\n\n\n改写以上组件就可以自定义样式。请确保配合使用[vuepress](https://vuepress.vuejs.org/zh/guide/)，否则vue组件将无法正常展示。\n\n\u003e `--component` 会覆盖原来的组件，请谨慎使用\n\n### 注释规范\n\n* `@version` - 版本号\n* `@author` - 作者\n* `@param` - 参数\n* `@returns` - 返回参数\n* `@intro` - 介绍\n* `@url` - 地址\n* `@image` - 图片\n* `@txt` - 文本\n* `@title` - 标题\n\n\u003e 注释中不带有@ 自动当做正常文本处理，带上@txt\n\n在代码中，块级注释和行级注释是等同的\n\n```js\n/**\n * @intro 这是介绍\n * @version 1.1.1\n * @author zhangzhihao\n * @url www.3zsd.com\n * @image ./images/1.jpeg\n * @param {string} apple - name.\n * @param {string} banana - name.\n * @returns {Number} Sum of a and b\n * 文本\n * 文本2\n */\n```\n\n等同于\n\n```js\n // @intro 这是介绍\n // @version 1.1.1\n // @author zhangzhihao\n // @url www.3zsd.com\n // @image ./images/1.jpeg\n // @param {string} apple - name.\n // @param {string} banana - name.\n // @returns {Number} Sum of a and b\n // 文本\n // 文本2\n```\n\n最后会转化成\n\n```md\n\u003e 这是介绍\n\n版本号: 1.1.1 \n\n作者: zhangzhihao\n\n地址: www.3zsd.com\n\n图片: ![](./images/1.jpeg)\n\n文本2\n\n**参数** \n\n| 参数 | 类型 | 说明\n| ---- | ---- | ---- | \n| apple | string | name. \n| banana | string | name. \n\n**返回值** \n\n| 类型 | 说明\n| ---- | ---- | \n| Number | Sum of a and b \n```\n\n设置了vue组件下会转化成：\n\n```md\n::: tip 介绍\n这是介绍\n:::\n\u003cvtmd-notes \n version=\"1.1.1\"\n versionCn=\"版本号\"\n author=\"zhangzhihao\"\n authorCn=\"作者\"\n url=\"www.3zsd.com\"\n urlCn=\"地址\"\n image=\"./images/1.jpeg\"\n imageCn=\"图片\"\n txt=\"文本2\"\n/\u003e \n\n**参数** \n\n| 参数 | 类型 | 说明\n| ---- | ---- | ---- | \n| apple | string | name. \n| banana | string | name. \n\n**返回值** \n\n| 类型 | 说明\n| ---- | ---- | \n| Number | Sum of a and b \n```\n\n[vue文件解析细节](docs/Vue.md)\n\n[umi解析细节](docs/Umi.md)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frywaroy%2Fvtmd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frywaroy%2Fvtmd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frywaroy%2Fvtmd/lists"}