unplugin-convention-routes/README.md

File system base router plugin for unplugin

<p align="center">
  <a href="https://www.npmjs.org/package/unplugin-convention-routes">
    <img src="https://img.shields.io/npm/v/unplugin-convention-routes.svg">
  </a>
  <a href="https://npmcharts.com/compare/unplugin-convention-routes?minimal=true">
    <img src="https://img.shields.io/npm/dm/@unplugin-convention-routes.svg">
  </a>
  <br>
</p>

<p align="center">unplugin-convention-routes</p>

- 🔥 基于文件系统的约定式路由解决方案。
- 🔥 基于`unplugin`对`vite-plugin-pages`进行了移植，能同时支持`vite`、`webpack`、`rsbuild`、`farm`等构建框架，并同时支持`react`、`vue`、`solid`三大框架。
- ⚠️ 尚在开发中，还不能正常使用，请勿使用。个人仅测试了`vue+vite`、`vue`+`rsbuild`、`react`+`vite`、`react`+`rsbuild`。

---

## 友情链接

- [unplugin](https://github.com/unjs/unplugin)
- [vite-plugin-pages](https://github.com/hannoeru/vite-plugin-pages)

## 📦 安装

```bash
pnpm i unplugin-convention-routes
```

## 🔨 示例
- https://github.com/liujiayii/unplugin-convention-routes/tree/main/examples