https://github.com/dewfall123/ruabick

Dumi like tool based on vitepress.
https://github.com/dewfall123/ruabick

document documentation-tool dumi vitepress vitepress-demo vue3

Last synced: 2 months ago
JSON representation

Dumi like tool based on vitepress.

• Host: GitHub
• URL: https://github.com/dewfall123/ruabick
• Owner: dewfall123
• Created: 2022-07-29T09:47:35.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-04-20T07:57:03.000Z (about 1 year ago)
• Last Synced: 2024-02-21T07:06:34.782Z (4 months ago)
• Topics: document, documentation-tool, dumi, vitepress, vitepress-demo, vue3
• Language: TypeScript
• Homepage: https://dewfall123.github.io/ruabick/
• Size: 1.31 MB
• Stars: 120
• Watchers: 3
• Forks: 27
• Open Issues: 17
• Metadata Files:
  • Readme: README.md

Lists

• awesome-vitepress-v1 - ruabick - Dumi like tool (:card_index_dividers: Projects Using VitePress / Projects)

README

        
# ruabick

一个 vue 组件库开发工具，类似[dumi](https://d.umijs.org/zh-CN)，基于 VitePress。

[English Introduction](./README.md) | 中文介绍

## 文档

[详细文档](https://dewfall123.github.io/ruabick/)

## 功能

### 1. 在 markdown 里面使用 demo 组件

```html

```

也可以这样使用(去掉反斜杠)

````html

\```vue:demo

  const number = 1;

  The number is {{number}}

\```

````

[渲染效果](https://dewfall123.github.io/ruabick/features/demo.html)

### 2. 自动生成 API 文档

在 markdown 里面使用``组件，只需要传入文件路径，自动生成文档。

> 基于`vue-docgen-api`项目, 参考了很多[arco-design-vue](https://github.com/arco-design/arco-design-vue/tree/main/packages/arco-vue-scripts)的代码。

```html

```

[查看效果](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)

对于 ts 文件，暂时只支持生成 ts 文件里面 interface 文档，而且必须要有 jsDoc 格式的注释。

```html

```

### 3. 文件映射

一般来说，我们使用 VitePress 会单独建一个`docs`目录，把文档集中放在此目录下。但是`Demo`文件放在`docs`目录下面会让`组件源码`和`demo.vue`隔得太远，放到一起更为合理。

所以`ruabick`能把 markdown 写在`src`目录下 main，通过 formatter 指定映射路径，把改文件映射到`docs`目录下面。

[更多说明](https://dewfall123.github.io/ruabick/features/mapping.html)

```md

// src/dir/demo-introduction.md

---

mapping:

path: /demo

---

```

## 开始使用

> 提供了脚手架创建新项目。实际上也可以基于 VirePress 安装`ruabick/*`的一些插件来使用，但是较为繁琐，不推荐。

```shell

pnpm create @ruabick/vlib

```

## Packages

> `ruabick`是一个 monorepo 库，包含的一些插件也可以单独使用。

- [@ruabick/md-demo-plugins](https://github.com/dewfall123/ruabick/tree/master/packages/md-demo-plugins)

- [vitepress-demo-block](https://github.com/dewfall123/ruabick/tree/master/packages/vitepress-demo-block)

- [vite-plugin-gen-api-doc](https://github.com/dewfall123/ruabick/tree/master/packages/vite-plugin-gen-api-doc)

## License

[MIT](http://opensource.org/licenses/MIT)