{"id":13449516,"url":"https://github.com/dewfall123/ruabick","last_synced_at":"2025-09-13T08:08:16.392Z","repository":{"id":50462122,"uuid":"519162182","full_name":"dewfall123/ruabick","owner":"dewfall123","description":"Dumi like tool based on vitepress.","archived":false,"fork":false,"pushed_at":"2023-04-20T07:57:03.000Z","size":1374,"stargazers_count":155,"open_issues_count":18,"forks_count":32,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-01T12:25:16.210Z","etag":null,"topics":["document","documentation-tool","dumi","vitepress","vitepress-demo","vue3"],"latest_commit_sha":null,"homepage":"https://dewfall123.github.io/ruabick/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dewfall123.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-29T09:47:35.000Z","updated_at":"2025-07-13T09:30:24.000Z","dependencies_parsed_at":"2024-10-28T15:37:23.288Z","dependency_job_id":null,"html_url":"https://github.com/dewfall123/ruabick","commit_stats":{"total_commits":63,"total_committers":4,"mean_commits":15.75,"dds":0.06349206349206349,"last_synced_commit":"f1916efc178a047cd25221c6f0467d2465ba2dfc"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dewfall123/ruabick","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dewfall123%2Fruabick","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dewfall123%2Fruabick/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dewfall123%2Fruabick/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dewfall123%2Fruabick/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dewfall123","download_url":"https://codeload.github.com/dewfall123/ruabick/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dewfall123%2Fruabick/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274935979,"owners_count":25376836,"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-09-13T02:00:10.085Z","response_time":70,"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":["document","documentation-tool","dumi","vitepress","vitepress-demo","vue3"],"created_at":"2024-07-31T06:00:40.982Z","updated_at":"2025-09-13T08:08:16.370Z","avatar_url":"https://github.com/dewfall123.png","language":"TypeScript","readme":"# ruabick\n\n一个 vue 组件库开发工具，类似[dumi](https://d.umijs.org/zh-CN)，基于 VitePress。\n\n[English Introduction](./README.md) | 中文介绍\n\n## 文档\n\n[详细文档](https://dewfall123.github.io/ruabick/)\n\n## 功能\n\n### 1. 在 markdown 里面使用 demo 组件\n\n```html\n\u003cdemo src=\"../demo.vue\" title=\"Demo block\" desc=\"use demo\"\u003e\u003c/demo\u003e\n```\n\n也可以这样使用(去掉反斜杠)\n\n````html\n\\```vue:demo\n\u003cscript lang=\"ts\" setup\u003e\n  const number = 1;\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n  \u003cspan\u003eThe number is {{number}}\u003c/span\u003e\n\u003c/template\u003e\n\\```\n````\n\n[渲染效果](https://dewfall123.github.io/ruabick/features/demo.html)\n\n### 2. 自动生成 API 文档\n\n在 markdown 里面使用`\u003cAPI\u003e`组件，只需要传入文件路径，自动生成文档。\n\n\u003e 基于`vue-docgen-api`项目, 参考了很多[arco-design-vue](https://github.com/arco-design/arco-design-vue/tree/main/packages/arco-vue-scripts)的代码。\n\n```html\n\u003cAPI src=\"./demo.vue\" lang=\"zh\"\u003e\u003c/API\u003e\n```\n\n[查看效果](https://dewfall123.github.io/ruabick/features/api.html#api-%E6%96%87%E6%A1%A3%E8%87%AA%E5%8A%A8%E7%94%9F%E6%88%90)\n\n对于 ts 文件，暂时只支持生成 ts 文件里面 interface 文档，而且必须要有 jsDoc 格式的注释。\n\n```html\n\u003cAPI src=\"./demo.ts\" lang=\"zh\"\u003e\u003c/API\u003e\n```\n\n### 3. 文件映射\n\n一般来说，我们使用 VitePress 会单独建一个`docs`目录，把文档集中放在此目录下。但是`Demo`文件放在`docs`目录下面会让`组件源码`和`demo.vue`隔得太远，放到一起更为合理。\n\n所以`ruabick`能把 markdown 写在`src`目录下 main，通过 formatter 指定映射路径，把改文件映射到`docs`目录下面。\n\n[更多说明](https://dewfall123.github.io/ruabick/features/mapping.html)\n\n```md\n// src/dir/demo-introduction.md\n\n---\n\nmapping:\npath: /demo\n\n---\n```\n\n## 开始使用\n\n\u003e 提供了脚手架创建新项目。实际上也可以基于 VirePress 安装`ruabick/*`的一些插件来使用，但是较为繁琐，不推荐。\n\n```shell\npnpm create @ruabick/vlib\n```\n\n## Packages\n\n\u003e `ruabick`是一个 monorepo 库，包含的一些插件也可以单独使用。\n\n- [@ruabick/md-demo-plugins](https://github.com/dewfall123/ruabick/tree/master/packages/md-demo-plugins)\n- [vitepress-demo-block](https://github.com/dewfall123/ruabick/tree/master/packages/vitepress-demo-block)\n- [vite-plugin-gen-api-doc](https://github.com/dewfall123/ruabick/tree/master/packages/vite-plugin-gen-api-doc)\n\n## License\n\n[MIT](http://opensource.org/licenses/MIT)\n","funding_links":[],"categories":[":card_index_dividers: Projects Using VitePress"],"sub_categories":["Projects"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdewfall123%2Fruabick","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdewfall123%2Fruabick","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdewfall123%2Fruabick/lists"}