https://github.com/saqqdy/egg-nuxt-tool
An egg plugin for using nuxt render programatically
https://github.com/saqqdy/egg-nuxt-tool
egg egg-nuxt egg-plugin middleware nuxt nuxt-plugin nuxt-render nuxt-tool
Last synced: 5 months ago
JSON representation
An egg plugin for using nuxt render programatically
- Host: GitHub
- URL: https://github.com/saqqdy/egg-nuxt-tool
- Owner: saqqdy
- License: mit
- Created: 2020-11-18T11:38:34.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-22T04:26:01.000Z (7 months ago)
- Last Synced: 2025-05-07T00:23:35.541Z (5 months ago)
- Topics: egg, egg-nuxt, egg-plugin, middleware, nuxt, nuxt-plugin, nuxt-render, nuxt-tool
- Language: JavaScript
- Homepage:
- Size: 435 KB
- Stars: 13
- Watchers: 2
- Forks: 1
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# egg-nuxt-tool
An egg plugin for using nuxt render programatically
[![NPM version][npm-image]][npm-url]
[![Codacy Badge][codacy-image]][codacy-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]
[![License][license-image]][license-url]
[![Sonar][sonar-image]][sonar-url]
## Install
```bash
# use pnpm
$ pnpm install egg-nuxt-tool
# use yarn
$ yarn add egg-nuxt-tool
```
## Usage
```js
// {app_root}/config/plugin.js
exports.nuxt = {
enable: true,
package: 'egg-nuxt-tool'
}
```
## Configuration
```js
// {app_root}/config/config.default.js
exports.nuxt = {
whitePath: [/^\/java\//, '/public', '/graphql'], // whiteList
...nuxtConfig // nuxtConfig
// ...
}
```
see [config/config.default.js](config/config.default.js) for more detail.
## Change logs
[Change logs](./CHANGELOG.md)
## Questions & Suggestions
Please open an issue [here](https://github.com/saqqdy/egg-nuxt-tool/issues).
## License
[MIT](LICENSE)
[npm-image]: https://img.shields.io/npm/v/egg-nuxt-tool.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-nuxt-tool
[codacy-image]: https://app.codacy.com/project/badge/Grade/f70d4880e4ad4f40aa970eb9ee9d0696
[codacy-url]: https://www.codacy.com/gh/saqqdy/egg-nuxt-tool/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saqqdy/egg-nuxt-tool&utm_campaign=Badge_Grade
[snyk-image]: https://snyk.io/test/npm/egg-nuxt-tool/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-nuxt-tool
[download-image]: https://img.shields.io/npm/dm/egg-nuxt-tool.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-nuxt-tool
[license-image]: https://img.shields.io/badge/License-MIT-blue.svg
[license-url]: LICENSE
[sonar-image]: https://sonarcloud.io/api/project_badges/quality_gate?project=saqqdy_egg-nuxt-tool
[sonar-url]: https://sonarcloud.io/dashboard?id=saqqdy_egg-nuxt-tool