open-index/open-npm huggingface dataset:
npm package: @nuxt-tui/auto-register
Description: Nuxt.JS Toast UI auto register module
Author: Kim Younggeon
Latest version: 0.2.1
Deprecated: Please use v1.0.0

# 🍞 🚀 Toast UI for Nuxt auto register module
[![code style: standard](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://standardjs.com/)

[Read Document](https://nuxt-tui.js.org)
npm package: @nuxt-tui/editor
Description: TOAST UI Editor for Nuxt.JS
Author: Kim Younggeon
Latest version: 1.0.0-alpha.3
Deprecated: Use @tui-nuxt/editor

<h1 align="center">🍞📝 TOAST UI Editor for Nuxt.JS</h1>
<p align="center">
    <a href="https://github.com/nhn/toast-ui.vue-editor"><b>TOAST UI Editor for Vue</b></a> wrapping module
</p>
<p align="center">
    <a href="https://github.com/nuxt-tui/editor/releases">
        <img alt="GitHub release" src="https://img.shields.io/github/release-pre/nuxt-tui/editor.svg?style=flat-square">
    </a>
    <a href="https://www.npmjs.com/settings/@nuxt-tui/editor">
        <img alt="npm (scoped)" src="https://img.shields.io/npm/v/@nuxt-tui/editor.svg?style=flat-square">
    </a>
    <a href="https://github.com/nuxt-tui/editor/blob/master/LICENSE">
        <img alt="GitHub" src="https://img.shields.io/github/license/nuxt-tui/editor.svg?style=flat-square">
    </a>
    <img alt="Code style is airbnb" src="https://img.shields.io/badge/code%20style-airbnb-success.svg?style=flat-square" />
</p>

## Install
```bash
$ yarn add @nuxt-tui/editor
# or
$ npm install --save @nuxt-tui/editor
```

## Setup
```javascript
// nuxt.config.js
module.exports = {
  // ...
  modules: ['@nuxt-tui/editor']
  tui: {
    editor: true // or options
  }
}
```

## Usage
```html
<template>
  <div id="top">
    <!-- Text Editor -->
    <TuiEditor
      mode="markdown"
      preview-style="vertical"
      height="300px"
    />

    <!-- Markdown Viewer -->
    <TuiEditorViewer
      :value="content"
    />
  </div>
</template>

<script>
export default {
  data: ({
    content: [
      'Hello World'
    ]
  })
};
</script
```

## Options
### stylesheet
 - type: object

Editor custom stylesheet. [read more](https://nuxtjs.org/api/configuration-css)

default:
```javascript
export default {
  tui: {
    editor: {
      stylesheet: {
          editor: 'tui-editor/dist/tui-editor.min.css',
          contents: 'tui-editor/dist/tui-editor-contents.min.css',
          codemirror: 'codemirror/lib/codemirror.css',
          codeHighlight: 'highlight.js/styles/github.css',
          colorPicker: 'tui-color-picker/dist/tui-color-picker.min.css'
        },
        // ...
    }
  }
}
```

#### stylesheet.editor
 - type: string

editor stylesheet

#### stylesheet.contents
 - type: string

viewer stylesheet

#### stylesheet.codemirror
 - type: string

wysiwyg editor style

#### stylesheet.codeHighlight
 - type: string

code block style

#### stylesheet.colorPicker
 - type: string

tui-color-picker style

### extensions
 - type: array
    - item: string

tui-editor extension list

default:
```javascript
export default {
  tui: {
    editor: {
      // ...
      extensions: []
    }
  }
}
```
npm package: @nuxt/bridge
Description: > Reduce the differences with Nuxt 3 and reduce the burden of migration to Nuxt 3.
Latest version: 3.6.1

# 🌉 Nuxt Bridge

> Reduce the differences with Nuxt 3 and reduce the burden of migration to Nuxt 3.

Bridge is a forward-compatibility layer that allows you to experience many of the new Nuxt 3 features by simply installing and enabling a Nuxt module.

Using Nuxt Bridge, you can make sure your project is (almost) ready for Nuxt 3 and you can gradually proceed with the transition to Nuxt 3.

⚠️ **Note:** Nuxt Bridge provides identical features to Nuxt 3 ([Nuxt 3 docs](https://nuxt.com/docs/getting-started/views#views)) but there are some limitations, notably that `useAsyncData` and `useFetch` composables are not available. Please read the rest of this page for details. 

⚠️ **Note:** Nuxt Bridge does not support Internet Explorer. Supported browsers are listed at https://caniuse.com/es6-module-dynamic-import.

🌱 **Note:** If you're starting a fresh Nuxt project, please skip this module and directly go to the [Nuxt 3 Installation](https://nuxt.com/docs/getting-started/introduction).
## Docs

Visit the [documentation site](https://nuxt.com/docs/bridge/overview) for migration guide.

## 💻 Development

- Clone repository
- Ensure you have the latest LTS version of Node.js installed
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable` to enable `pnpm` and `yarn`
- Install dependencies with `pnpm install`
- Run `pnpm dev:prepare` to activate passive development
- Open playground with `pnpm dev`

Learn more about in our documentation on [how to contribute to Nuxt](https://nuxt.com/docs/community/contribution).

## License

[MIT](https://github.com/nuxt/nuxt.js/blob/dev/LICENSE)
npm package: @nuxt/bridge-schema
Description: > Reduce the differences with Nuxt 3 and reduce the burden of migration to Nuxt 3.
Latest version: 3.6.1

# 🌉 Nuxt Bridge

> Reduce the differences with Nuxt 3 and reduce the burden of migration to Nuxt 3.

Bridge is a forward-compatibility layer that allows you to experience many of the new Nuxt 3 features by simply installing and enabling a Nuxt module.

Using Nuxt Bridge, you can make sure your project is (almost) ready for Nuxt 3 and you can gradually proceed with the transition to Nuxt 3.

⚠️ **Note:** Nuxt Bridge provides identical features to Nuxt 3 ([Nuxt 3 docs](https://nuxt.com/docs/getting-started/views#views)) but there are some limitations, notably that `useAsyncData` and `useFetch` composables are not available. Please read the rest of this page for details. 

⚠️ **Note:** Nuxt Bridge does not support Internet Explorer. Supported browsers are listed at https://caniuse.com/es6-module-dynamic-import.

🌱 **Note:** If you're starting a fresh Nuxt project, please skip this module and directly go to the [Nuxt 3 Installation](https://nuxt.com/docs/getting-started/introduction).
## Docs

Visit the [documentation site](https://nuxt.com/docs/bridge/overview) for migration guide.

## 💻 Development

- Clone repository
- Ensure you have the latest LTS version of Node.js installed
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable` to enable `pnpm` and `yarn`
- Install dependencies with `pnpm install`
- Run `pnpm dev:prepare` to activate passive development
- Open playground with `pnpm dev`

Learn more about in our documentation on [how to contribute to Nuxt](https://nuxt.com/docs/community/contribution).

## License

[MIT](https://github.com/nuxt/nuxt.js/blob/dev/LICENSE)
npm package: @nuxt/content
Description: Write your content inside your Nuxt app
Latest version: 3.12.0

[![nuxt-content-social-card](./.github/social-card.png)](https://content.nuxt.com)

# Nuxt Content

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
[![Volta][volta-src]][volta-href]

Nuxt Content reads the `content/` directory in your project, parses `.md`, `.yml`, `.csv` or `.json` files and creates a powerful data layer for your application. Bonus, use Vue components in Markdown with the [MDC syntax](https://content.nuxt.com/docs/files/markdown).

- [📖 &nbsp;Read the documentation](https://content.nuxt.com)
- [✨ &nbsp;Intro video](https://www.youtube.com/watch?v=o9e12WbKrd8)
- [✍️ &nbsp;Nuxt Studio](https://nuxt.studio)

## Features

- [**Nuxt 3**](https://nuxt.com) support
- Work in serverless and edge environments (Cloudflare Workers, etc.)
- Render Vue components in Markdown with the [MDC syntax](https://content.nuxt.com/docs/files/markdown)
- Fully typed collections and queries
- Navigation generation
- Blazing fast hot module replacement in development
- Code highlighting with [**Shiki**](https://github.com/shikijs/shiki)
- Powerful query builder on top of SQLite database
- [... and more](https://content.nuxt.com)

## 💻 Development

- Clone repository
- Install dependencies using `pnpm install`
- Prepare using `pnpm dev:prepare`
- Build using `pnpm prepack`
- Try playground using `pnpm dev`
- Test using `pnpm test`

## License

[MIT](./LICENSE) - Made with 💚

[npm-version-src]: https://img.shields.io/npm/v/@nuxt/content/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@nuxt/content

[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxt/content.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npm.chart.dev/@nuxt/content

[license-src]: https://img.shields.io/github/license/nuxt/content.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://github.com/nuxt/content/blob/main/LICENSE

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt
[nuxt-href]: https://nuxt.com

[volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg
[volta-href]: https://volta.net/nuxt/content?utm_source=readme_nuxt_content
npm package: @nuxt/content-edge
Description: Write your content inside your Nuxt app
Latest version: 2.13.4-28887017.d8792ef

[![nuxt-content-social-card](./docs/public/social-card.png)](https://content.nuxt.com)

# Nuxt Content

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
[![Volta][volta-src]][volta-href]

Nuxt Content reads the `content/` directory in your project, parses `.md`, `.yml`, `.csv` or `.json` files and creates a powerful data layer for your application. Bonus, use Vue components in Markdown with the [MDC syntax](https://content.nuxt.com/usage/markdown).

- [📖 &nbsp;Read the documentation](https://content.nuxt.com)
- [👾 &nbsp;Playground](https://stackblitz.com/github/nuxt/content/tree/main/examples/essentials/hello-world?file=app.vue)
- [✨ &nbsp;Intro video](https://www.youtube.com/watch?v=o9e12WbKrd8)
- [✍️ &nbsp;Nuxt Studio](https://nuxt.studio)

## Features

- [**Nuxt 3**](https://nuxt.com) support
- A Markdown syntax made for Vue components ([**MDC**](https://content.nuxt.com/usage/markdown))
- Navigation generation
- Code highlighting with [**Shiki**](https://github.com/shikijs/shiki)
- Blazing fast hot module replacement in development
- Powerful query builder (MongoDB like)
- Table of contents generation
- Also handles CSV, YAML and JSON(5)
- Extend with hooks and content plugins
- [... and more](https://content.nuxt.com)

## Nuxt 2

Nuxt 2 is supported with Content v1, documentation is on <https://content.nuxt.com/v1> and the code on the [v1](https://github.com/nuxt/content/tree/v1) branch.

## 💻 Development

> [!NOTE]
> This repository uses bash scripts for development and testing. If you are on Windows, you can use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) or [Git Bash](https://gitforwindows.org/).

- Clone repository
- Install dependencies using `pnpm install`
- Prepare using `pnpm prepare`
- Build using `pnpm build`
- Try playground using `pnpm dev`
- Test using `pnpm test`

## License

[MIT](./LICENSE) - Made with 💚

[npm-version-src]: https://img.shields.io/npm/v/@nuxt/content/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@nuxt/content

[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxt/content.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npm.chart.dev/@nuxt/content

[license-src]: https://img.shields.io/github/license/nuxt/content.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://github.com/nuxt/content/blob/main/LICENSE

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
[nuxt-href]: https://nuxt.com

[volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg
[volta-href]: https://volta.net/nuxt/content?utm_source=readme_nuxt_content
npm package: @nuxt/content-theme-docs
Description: [![npm version][npm-version-src]][npm-version-href] [![npm downloads][npm-downloads-src]][npm-downloads-href] [![License][license-src]][license-href] [![lerna][lerna-src]][lerna-href]
Latest version: 0.11.1

# @nuxt/content-theme-docs

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![lerna][lerna-src]][lerna-href]

> Create your documentation with @nuxt/content docs theme in seconds!

## Getting Started

```bash
# Yarn
yarn create nuxt-content-docs <project-name>

# NPX
npx create-nuxt-content-docs <project-name>
```

It's as simple as that!

[📖 Read more](https://content.nuxtjs.org/themes/docs)

## License

[MIT License](../../LICENSE)

<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/@nuxt/content-theme-docs/latest.svg
[npm-version-href]: https://npmjs.com/package/@nuxt/content-theme-docs

[npm-downloads-src]: https://img.shields.io/npm/dt/@nuxt/content-theme-docs.svg
[npm-downloads-href]: https://npmjs.com/package/@nuxt/content-theme-docs

[license-src]: https://img.shields.io/npm/l/@nuxt/content.svg
[license-href]: https://npmjs.com/package/@nuxt/content

[lerna-src]: https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg
[lerna-href]: https://lerna.js.org/
npm package: @nuxt/devtools-ui-kit
Description: <a href="https://www.npmjs.com/package/@nuxt/devtools-ui-kit"><img src="https://flat.badgen.net/npm/v/@nuxt/devtools-ui-kit" alt="npm version"></a>
Latest version: 4.0.0-alpha.4

# @nuxt/devtools-ui-kit

<a href="https://www.npmjs.com/package/@nuxt/devtools-ui-kit"><img src="https://flat.badgen.net/npm/v/@nuxt/devtools-ui-kit" alt="npm version"></a>

> **Warning**: This library is heavily working in progress. Breaking changes may not follow semver. Pin the version if used.

UI kit for module authors to build embedded views for Nuxt DevTools.

Please refer to the [DevTools UI Kit](https://devtools.nuxt.com/module/ui-kit) for the full documentation.
npm package: @nuxt/docs
Description: Documentation for Nuxt in raw markdown
Latest version: 4.4.2

---
navigation: false
---

# Nuxt Docs

This repository contains the documentation of Nuxt, hosted on <https://nuxt.com/docs/4.x/getting-started/introduction>

## Contributing

Have a look at <https://github.com/nuxt/nuxt.com> to run the website locally.
npm package: @nuxt/eslint
Description: Generate ESLint config from current Nuxt settings
Latest version: 1.15.2

# `@nuxt/eslint`

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]

All-in-one ESLint integration for Nuxt. It generates a project-aware [ESLint flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new) and provides the ability to optionally run ESLint check along side the dev server.

Refer to the [documentation](https://eslint.nuxt.com/packages/module) for more details.

## License

MIT

<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/@nuxt/eslint/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@nuxt/eslint

[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxt/eslint.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/@nuxt/eslint

[license-src]: https://img.shields.io/npm/l/@nuxt/eslint.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/@nuxt/eslint

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt
[nuxt-href]: https://nuxt.com
npm package: @nuxt/eslint-config
Description: ESLint config for Nuxt projects
Latest version: 1.15.2

# `@nuxt/eslint-config`

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]

Shared ESLint config for Nuxt 3 projects. Unopinionated by default, but customizable.

Refer to the [documentation](https://eslint.nuxt.com/packages/config) for more details.

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/@nuxt/eslint-config?style=flat-square
[npm-version-href]: https://npmjs.com/package/@nuxt/eslint-config
[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxt/eslint-config?style=flat-square
[npm-downloads-href]: https://npmjs.com/package/@nuxt/eslint-config
[github-actions-src]: https://img.shields.io/github/workflow/status/nuxt/eslint-config/ci/main?style=flat-square
[github-actions-href]: https://github.com/nuxt/eslint-config/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/gh/nuxt/eslint-config/main?style=flat-square
[codecov-href]: https://codecov.io/gh/nuxt/eslint-config
[lgtm-src]: https://img.shields.io/lgtm/grade/javascript/github/nuxt/eslint-config?style=flat-square
[lgtm-href]: https://lgtm.com/projects/g/nuxt/eslint-config
[bundlephobia-src]: https://img.shields.io/bundlephobia/minzip/@nuxt/eslint-config?style=flat-square
[bundlephobia-href]: https://bundlephobia.com/package/@nuxt/eslint-config
npm package: @nuxt/eslint-plugin
Description: ESLint plugin for Nuxt
Latest version: 1.15.2

# `@nuxt/eslint-plugin`

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]

ESLint plugin of additional rules for Nuxt 3.

Refer to the [documentation](https://eslint.nuxt.com/packages/plugin) for more details.

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/@nuxt/eslint-plugin?style=flat-square
[npm-version-href]: https://npmjs.com/package/@nuxt/eslint-plugin
[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxt/eslint-plugin?style=flat-square
[npm-downloads-href]: https://npmjs.com/package/@nuxt/eslint-plugin
[github-actions-src]: https://img.shields.io/github/workflow/status/nuxt/eslint-plugin/ci/main?style=flat-square
[github-actions-href]: https://github.com/nuxt/eslint-plugin/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/gh/nuxt/eslint-plugin/main?style=flat-square
[codecov-href]: https://codecov.io/gh/nuxt/eslint-plugin
[lgtm-src]: https://img.shields.io/lgtm/grade/javascript/github/nuxt/eslint-plugin?style=flat-square
[lgtm-href]: https://lgtm.com/projects/g/nuxt/eslint-plugin
[bundlephobia-src]: https://img.shields.io/bundlephobia/minzip/@nuxt/eslint-plugin?style=flat-square
[bundlephobia-href]: https://bundlephobia.com/package/@nuxt/eslint-plugin
npm package: @nuxt/experiment-auto-plugins
Description: Automatically add all plugins from `plugins/**/*.js` + support `.nuxtignore` to ignore specific plugins.
Latest version: 0.1.0

# `auto-plugins`

Automatically add all plugins from `plugins/**/*.js` + support `.nuxtignore` to ignore specific plugins.

## TODO

- [@nuxt/builder] Support duplicate detection
- [@nuxt/builder] Add hook to extend plugins
npm package: @nuxt/fonts
Description: Automatic font configuration for Nuxt apps
Latest version: 0.14.0

![nuxt-fonts](https://github.com/nuxt/fonts/assets/904724/75121716-05fd-459b-9223-42eb9dc8646f)

# Nuxt Fonts

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
[![Volta][volta-src]][volta-href]
[![nuxt.care health](https://img.shields.io/endpoint?url=https://nuxt.care/api/badge/fonts)](https://nuxt.care/?search=fonts)

Plug-and-play custom web font optimization and configuration for Nuxt apps.

- [📖 &nbsp;Read Documentation](https://fonts.nuxt.com)
- [👾 &nbsp;Playground](https://stackblitz.com/github/nuxt/fonts/tree/main/playgrounds/basic)

## Features

- ✨ zero-configuration required
- 🔡 built-in providers (`google`, `bunny`, `fontshare`, `fontsource`, `adobe`, `npm`, `local` - more welcome!)
- 💪 custom providers for full control
- ⏬ local download support (until `nuxt/assets` lands)
- ⚡️ automatic font metric optimisation powered by [**fontaine**](https://github.com/unjs/fontaine) and [**capsize**](https://github.com/seek-oss/capsize)
- 🔥 build/dev time font caching powered by [**unstorage**](https://github.com/unjs/unstorage)

👉 See [Nuxt Fonts RFC](https://github.com/nuxt/nuxt/discussions/22014) for full details and discussion.

### Installation

Install `@nuxt/fonts` dependency to your project:

```sh
npx nuxt module add fonts
```

### Contributing

- Clone this repository
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
- Install dependencies using `pnpm install`
- Run `pnpm dev:prepare` to generate type stubs.
- Use `pnpm dev` to start [the basic playground](./playgrounds/basic) in development mode.

## 📑 License

Published under the [MIT License](./LICENSE)

<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/@nuxt/fonts/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npm.chart.dev/@nuxt/fonts

[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxt/fonts.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npm.chart.dev/@nuxt/fonts/v/latest

[license-src]: https://img.shields.io/npm/l/@nuxt/fonts.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/@nuxt/fonts/v/latest

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt
[nuxt-href]: https://nuxt.com

[volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg
[volta-href]: https://volta.net/nuxt/fonts?utm_source=nuxt_fonts_readme
npm package: @nuxt/fonts-nightly
Description: Automatic font configuration for Nuxt apps
Latest version: 0.14.1-20260305-121451-a5c61fb

![nuxt-fonts](https://github.com/nuxt/fonts/assets/904724/75121716-05fd-459b-9223-42eb9dc8646f)

# Nuxt Fonts

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
[![Volta][volta-src]][volta-href]
[![nuxt.care health](https://img.shields.io/endpoint?url=https://nuxt.care/api/badge/fonts)](https://nuxt.care/?search=fonts)

Plug-and-play custom web font optimization and configuration for Nuxt apps.

- [📖 &nbsp;Read Documentation](https://fonts.nuxt.com)
- [👾 &nbsp;Playground](https://stackblitz.com/github/nuxt/fonts/tree/main/playgrounds/basic)

## Features

- ✨ zero-configuration required
- 🔡 built-in providers (`google`, `bunny`, `fontshare`, `fontsource`, `adobe`, `npm`, `local` - more welcome!)
- 💪 custom providers for full control
- ⏬ local download support (until `nuxt/assets` lands)
- ⚡️ automatic font metric optimisation powered by [**fontaine**](https://github.com/unjs/fontaine) and [**capsize**](https://github.com/seek-oss/capsize)
- 🔥 build/dev time font caching powered by [**unstorage**](https://github.com/unjs/unstorage)

👉 See [Nuxt Fonts RFC](https://github.com/nuxt/nuxt/discussions/22014) for full details and discussion.

### Installation

Install `@nuxt/fonts` dependency to your project:

```sh
npx nuxt module add fonts
```

### Contributing

- Clone this repository
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
- Install dependencies using `pnpm install`
- Run `pnpm dev:prepare` to generate type stubs.
- Use `pnpm dev` to start [the basic playground](./playgrounds/basic) in development mode.

## 📑 License

Published under the [MIT License](./LICENSE)

<!-- Badges -->
[npm-version-src]: https://npmx.dev/api/registry/badge/version/@nuxt/fonts
[npm-version-href]: https://npm.chart.dev/@nuxt/fonts

[npm-downloads-src]: https://npmx.dev/api/registry/badge/downloads/@nuxt/fonts
[npm-downloads-href]: https://npm.chart.dev/@nuxt/fonts/v/latest

[license-src]: https://npmx.dev/api/registry/badge/license/@nuxt/fonts
[license-href]: https://npmx.dev/package/@nuxt/fonts/v/latest

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt
[nuxt-href]: https://nuxt.com

[volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg
[volta-href]: https://volta.net/nuxt/fonts?utm_source=nuxt_fonts_readme
npm package: @nuxt/http
Description: Universal HTTP Module for Nuxt.js
Author: Pooya Parsa
Latest version: 0.6.4

[![@nuxt/http](https://http.nuxtjs.org/preview.png)](https://http.nuxtjs.org)

# Nuxt HTTP

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
[![Codecov][codecov-src]][codecov-href]
[![License][license-src]][license-href]
[![Standard JS][standard-js-src]][standard-js-href]

> HTTP module for Nuxt with a universal way to make HTTP requests to the API backend.

- [✨ &nbsp;Release Notes](https://http.nuxtjs.org/releases)
- [📖 &nbsp;Documentation](https://http.nuxtjs.org)

## Features

- The fluent [ky](https://github.com/sindresorhus/ky) API has been extended with enhancements and shortcuts
- Highly customizable options support for [BaseURL](https://http.nuxtjs.org/options#baseurl)
- Automatically proxy cookies and headers when making requests from server side
- Best practices to avoid token sharing when making server side requests
- Easy proxy support to avoid CORS problems and making deployment easier

[📖 &nbsp;Read more](https://http.nuxtjs.org)

## Development

1. Clone this repository
2. Install dependencies using `yarn install`
3. Start development server using `yarn dev`
4. Then go for instance to `http://localhost:3000/mounted`

## 📖 Contribute to the documentation 

1. Go into the docs folder
2. Install dependencies using `yarn install`
3. Start development server using `yarn dev`

## 📑 License

[MIT License](./LICENSE)

Copyright (c) Nuxt.js Team

<!-- Badges -->
[npm-version-src]: https://flat.badgen.net/npm/v/@nuxt/http
[npm-version-href]: https://npmjs.com/package/@nuxt/http
[npm-downloads-src]: https://flat.badgen.net/npm/dm/@nuxt/http
[npm-downloads-href]: https://npmjs.com/package/@nuxt/http
[github-actions-ci-src]: https://github.com/nuxt/http/workflows/ci/badge.svg
[github-actions-ci-href]: https://github.com/nuxt/http/actions?query=workflow%3Aci
[checks-src]: https://flat.badgen.net/github/checks/nuxt/http/master
[checks-href]: https://github.com/nuxt/http/actions
[codecov-src]: https://flat.badgen.net/codecov/c/github/nuxt/http
[codecov-href]: https://codecov.io/gh/nuxt/http
[standard-js-src]: https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square
[standard-js-href]: https://standardjs.com
[license-src]: https://img.shields.io/npm/l/@nuxt/http.svg
[license-href]: https://npmjs.com/package/@nuxt/http
npm package: @nuxt/image
Description: Nuxt Image Module
Latest version: 2.0.0

[![nuxt-image-social-card](https://github-production-user-asset-6210df.s3.amazonaws.com/904724/261574805-5af726c5-0113-4676-9ee9-c464393caee0.png)](https://image.nuxt.com)

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
[![Volta][volta-src]][volta-href]

# Nuxt Image

Plug-and-play image optimization for Nuxt apps. Resize and transform your images using built-in optimizer or your favorite images CDN.

- [📖 &nbsp;Read Documentation](https://image.nuxt.com)
- [👾 &nbsp;Playground](https://stackblitz.com/github/nuxt/image/tree/main/example)

## Features

- `<nuxt-img>` drop-in replacement for the native `<img>` element
- `<nuxt-picture>` drop-in replacement for the native `<picture>` element.
- Built-in image resizer and transformer with [unjs/ipx](https://github.com/unjs/ipx)
- Support 20+ providers
- Generate responsive sizes
- Optimize using modern formats such as webp and avif
- [... and more](https://image.nuxtjs.org)

### Installation

Install `@nuxt/image` dependency to your project:

```sh
npx nuxt module add image
```

## Nuxt 2

**Note:** This branch is for **Nuxt 3** compatible module. Checkout [`v0` branch](https://github.com/nuxt/image/tree/v0) for **Nuxt 2** support. ([Announcement](https://github.com/nuxt/image/discussions/548))

### Contributing

- Clone this repository
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
- Install dependencies using `pnpm install`
- Run `pnpm dev:prepare` to generate type stubs.
- Use `pnpm dev` to start [playground](./playground) in development mode.

## 📑 License

Published under the [MIT License](./LICENSE)

<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/@nuxt/image/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@nuxt/image/v/latest

[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxt/image.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npm.chart.dev/@nuxt/image

[license-src]: https://img.shields.io/npm/l/@nuxt/image.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/@nuxt/image

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
[nuxt-href]: https://nuxt.com

[volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg
[volta-href]: https://volta.net/nuxt/image?utm_source=nuxt_image_readme
npm package: @nuxt/image-edge
Description: Nuxt Image Module
Latest version: 1.3.0-28493895.369b747

[![nuxt-image-social-card](https://github-production-user-asset-6210df.s3.amazonaws.com/904724/261574805-5af726c5-0113-4676-9ee9-c464393caee0.png)](https://image.nuxt.com)

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
[![Volta][volta-src]][volta-href]

# Nuxt Image

Plug-and-play image optimization for Nuxt apps. Resize and transform your images using built-in optimizer or your favorite images CDN.

- [📖 &nbsp;Read Documentation](https://image.nuxt.com)
- [👾 &nbsp;Playground](https://stackblitz.com/github/nuxt/image/tree/main/example)

## Features

- `<nuxt-img>` drop-in replacement for the native `<img>` element
- `<nuxt-picture>` drop-in replacement for the native `<picture>` element.
- Built-in image resizer and transformer with [unjs/ipx](https://github.com/unjs/ipx)
- Support 20+ providers
- Generate responsive sizes
- Optimize using modern formats such as webp and avif
- [... and more](https://image.nuxtjs.org)

## Nuxt 2

**Note:** This branch is for **Nuxt 3** compatible module. Checkout [`v0` branch](https://github.com/nuxt/image/tree/v0) for **Nuxt 2** support. ([Announcement](https://github.com/nuxt/image/discussions/548))

### Contributing

- Clone this repository
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
- Install dependencies using `pnpm install`
- Run `pnpm dev:prepare` to generate type stubs.
- Use `pnpm dev` to start [playground](./playground) in development mode.

## 📑 License

Published under the [MIT License](./LICENSE)

<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/@nuxt/image/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@nuxt/image/v/rc

[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxt/image.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/@nuxt/image/v/rc

[license-src]: https://img.shields.io/npm/l/@nuxt/image.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/@nuxt/image/v/rc

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
[nuxt-href]: https://nuxt.com

[volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg
[volta-href]: https://volta.net/nuxt/image?utm_source=nuxt_image_readme
npm package: @nuxt/image-nightly
Description: Nuxt Image Module
Latest version: 2.0.1-20260403-090904-7e561f6

[![nuxt-image-social-card](https://github-production-user-asset-6210df.s3.amazonaws.com/904724/261574805-5af726c5-0113-4676-9ee9-c464393caee0.png)](https://image.nuxt.com)

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]
[![Volta][volta-src]][volta-href]
[![nuxt.care health](https://img.shields.io/endpoint?url=https://nuxt.care/api/badge/image)](https://nuxt.care/?search=image)

# Nuxt Image

Plug-and-play image optimization for Nuxt apps. Resize and transform your images using built-in optimizer or your favorite images CDN.

- [📖 &nbsp;Read Documentation](https://image.nuxt.com)
- [👾 &nbsp;Playground](https://stackblitz.com/github/nuxt/image/tree/main/example)

## Features

- `<nuxt-img>` drop-in replacement for the native `<img>` element
- `<nuxt-picture>` drop-in replacement for the native `<picture>` element.
- Built-in image resizer and transformer with [unjs/ipx](https://github.com/unjs/ipx)
- Support 20+ providers
- Generate responsive sizes
- Optimize using modern formats such as webp and avif
- [... and more](https://image.nuxtjs.org)

### Installation

Install `@nuxt/image` dependency to your project:

```sh
npx nuxt module add image
```

## Nuxt 2

**Note:** This branch is for **Nuxt 3** compatible module. Checkout [`v0` branch](https://github.com/nuxt/image/tree/v0) for **Nuxt 2** support. ([Announcement](https://github.com/nuxt/image/discussions/548))

### Contributing

- Clone this repository
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
- Install dependencies using `pnpm install`
- Run `pnpm dev:prepare` to generate type stubs.
- Use `pnpm dev` to start [playground](./playground) in development mode.

## 📑 License

Published under the [MIT License](./LICENSE)

<!-- Badges -->
[npm-version-src]: https://npmx.dev/api/registry/badge/version/@nuxt/image
[npm-version-href]: https://npmx.dev/package/@nuxt/image/v/latest

[npm-downloads-src]: https://npmx.dev/api/registry/badge/downloads/@nuxt/image
[npm-downloads-href]: https://npm.chart.dev/@nuxt/image

[license-src]: https://npmx.dev/api/registry/badge/license/@nuxt/image
[license-href]: https://npmx.dev/package/@nuxt/image

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt
[nuxt-href]: https://nuxt.com

[volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg
[volta-href]: https://volta.net/nuxt/image?utm_source=nuxt_image_readme
npm package: @nuxt/integrations
Description: [![automated](https://flat.badgen.net/badge/publish/automated/green)](#) [![npm version](https://flat.badgen.net/npm/v/@nuxt/integrations)](https://www.npmjs.com/package/@nuxt/integrations)
Latest version: 0.5.0-c88682

# Nuxt Integrations DB (WIP)

[![automated](https://flat.badgen.net/badge/publish/automated/green)](#)
[![npm version](https://flat.badgen.net/npm/v/@nuxt/integrations)](https://www.npmjs.com/package/@nuxt/integrations)

- PR: https://github.com/nuxt/nuxtjs.org/pull/605

## Contribution

- If you feel a module is missing, please create a new [issue](https://github.com/nuxt/integrations/issues/new)
- If some meta is wrong, feel free directly opening a PR

## License

MIT
npm package: @nuxt/loading-screen
Description: [![Github Actions CI][github-actions-src]][github-actions-href] [![Standard JS][standard-js-src]][standard-js-href] [![npm version][npm-version-src]][npm-version-href] [![npm downloads][npm-downloads-src]][npm-downloads-href] [![package phobia][package-ph
Latest version: 2.0.4

## Loading Screen

[![Github Actions CI][github-actions-src]][github-actions-href]
[![Standard JS][standard-js-src]][standard-js-href]
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![package phobia][package-phobia-src]][package-phobia-href]


This module is internally being used by [nuxt.js](https://github.com/nuxt/nuxt.js) to show loading screen.

![nuxt-loading-screen](https://user-images.githubusercontent.com/904724/54605661-12812680-4a4a-11e9-92e0-e7d7ed3a7c66.gif)

## License

MIT - Made with 💖 By Nuxt team!

<!-- Refs -->
[github-actions-src]: https://github.com/nuxt/loading-screen/workflows/ci/badge.svg?branch=master
[github-actions-href]: https://github.com/nuxt/loading-screen/actions?query=workflow%3Aci

[standard-js-src]: https://flat.badgen.net/badge/code%20style/standard/green
[standard-js-href]: https://standardjs.com

[npm-version-src]: https://flat.badgen.net/npm/v/@nuxt/loading-screen/latest
[npm-version-href]: https://npmjs.com/package/@nuxt/loading-screen

[npm-downloads-src]: https://flat.badgen.net/npm/dt/@nuxt/loading-screen
[npm-downloads-href]: https://npmjs.com/package/@nuxt/loading-screen

[package-phobia-src]: https://flat.badgen.net/packagephobia/install/@nuxt/loading-screen
[package-phobia-href]: https://packagephobia.now.sh/result?p=@nuxt/loading-screen
npm package: @nuxt/markdown
Description: Nuxt-flavoured fork of @dimerapp/markdown
Author: Jonas Galvez
Latest version: 0.0.21

# @nuxt/markdown

A Nuxt-flavoured fork of [`@dimerapp/markdown`](https://github.com/dimerapp/markdown) that features granular control [unified](https://github.com/unifiedjs/unified) stream.

## Install

```sh
npm i @nuxt/markdown --save
```

## Usage

```js
import Markdown from '@nuxt/markdown'

const md = new Markdown({ toc: false, sanitize: false })
const contents = await md.toHTML(markdownSourceString)
```

## Processing layers

```js
import Markdown from '@nuxt/markdown'
import remarkContainer from 'remark-container'

const md = new Markdown({
  extend({ layers }) {
    layers['remark-container'] = remarkContainer
  }
})

const rendered = await md.toMarkup(markdownSourceString)
```

Assigning is equivalent to **pushing** to the **last second position** of the internal `layers` Array. 

This is because the last step is `rehype-stringify`, responsible for the final HTML output, but we still want to be able to customize/remove that if needed.

You can also use Array methods directly:

```js
const md = new Markdown({
  extend({ layers }) {
    layers.splice(pos, 0, ['remark-container', remarkContainer])
  }
})
```

This is the default `layers` Array provided to a `@nuxt/markdown` instance:

```js
const layers = [
  ['remark-parse', remarkParse],
  ['remark-slug', remarkSlug],
  ['remark-autolink-headings', autolinkHeadings],
  ['remark-macro', macroEngine.transformer],
  ['remark-squeeze-paragraphs', squeezeParagraphs],
  ['remark-rehype', remarkRehype, { allowDangerousHTML: true }],
  ['rehype-raw', rehypeRaw],
  ['rehype-prism', rehypePrism, { ignoreMissing: true }],
  ['rehype-stringify', rehypeStringify]
]
```

Each layer begins with an arbitrary id, to make addressing specific layers easier.

## Custom remark-rehype handlers

You can also pass in a `handlers` object to the `Markdown` constructor to define custom [remark-rehype](https://github.com/remarkjs/remark-rehype) handlers.

See a [list of available overridable handlers here](https://github.com/nuxt/markdown/tree/develop/src/handlers).

## Adding macros

**@nuxt/markdown** includes [remark-macro](https://github.com/dimerapp/remark-macro), a nifty library that adds macro support to Markdown files. To add macros, use the `extend()` function like in the previous examples:

```js
import Markdown from '@nuxt/markdown'

const md = new Markdown({
  extend({ macros }) {
    macros.alert = (content, props, { transformer, eat }) => {
      return {
        type: 'AlertNode',
        data: {
          hName: 'div',
          hClassNames: ['alert alert-note'],
          hChildren: transformer.tokenizeBlock(content, eat.now())
        }
      } 
    }
  }
})

const markdown = `
# Hello world

[alert]
This is an alert
[/alert]
`

const rendered = await md.toMarkup(markdown)
```

Example taken from [dimerapp/remark-macro](https://github.com/dimerapp/remark-macro).

## NuxtPress roadmap

@nuxt/markdown was created mainly for [NuxtPress](https://nuxt.press) and is part of its **[roadmap](https://nuxt.press/en/roadmap/#roadmap)**.
npm package: @nuxt/nitro
Description: This is a placeholder package. Please use [@nuxt/nitro-edge](https://www.npmjs.com/package/@nuxt/nitro-edge). Learn more: https://v3.nuxtjs.org
Latest version: 0.10.0

This is a placeholder package. Please use [@nuxt/nitro-edge](https://www.npmjs.com/package/@nuxt/nitro-edge). Learn more: https://v3.nuxtjs.org
npm package: @nuxt/postcss8
Description: Since [nuxt@2.15](https://github.com/nuxt/nuxt.js/releases/tag/v2.15.0) nuxt supports opting-in to use `postcss@8` (via [nuxt/nuxt.js#8546](https://github.com/nuxt/nuxt.js/pull/8546)).
Latest version: 1.1.3

# postcss8 support for nuxt 2.15+

Since [nuxt@2.15](https://github.com/nuxt/nuxt.js/releases/tag/v2.15.0) nuxt supports opting-in to use `postcss@8` (via [nuxt/nuxt.js#8546](https://github.com/nuxt/nuxt.js/pull/8546)).

Upgrade is pending for [csstools/postcss-preset-env#191](https://github.com/csstools/postcss-preset-env/issues/191) (see [nuxt/nuxt.js#8087](https://github.com/nuxt/nuxt.js/issues/8087) and [nuxt/nuxt.js#8408](https://github.com/nuxt/nuxt.js/pull/8408))

In the meantime, this module allows rapid migration:

- Ensures supported nuxt version is used (`>= 2.15.3`)
- Forces to use upgraded dependencies using `__NUXT_PREPATHS__`
- Will be updated accordingly to self-disable when a nuxt version with default postcss8 detected
- Use `autoprefixer` instead of `postcss-preset-env`

## Usage

Install `@nuxt/postcss8` as `devDependency`:

```sh
yarn add --dev @nuxt/postcss8
# or
npm i -D @nuxt/postcss8
```

Add `@nuxt/postcss8` to `buildModules` in `nuxt.config`:

```js
// nuxt.config
export default {
  buildModules: [
    '@nuxt/postcss8'
  ]
}
```

### For module authors

If you have a nuxt module that requires postcss@8, install `postcss@8` and `@nuxt/postcss8` as `dependency`:

```sh
yarn add postcss@8 @nuxt/postcss8
# or
npm i postcss@8 @nuxt/postcss8
```

Inside module:
```js
export default async function() {
  await this.addModule(require('@nuxt/postcss8'))
}
```
npm package: @nuxt/serverless
Description: [![npm version][npm-version-src]][npm-version-href] [![npm downloads][npm-downloads-src]][npm-downloads-href] [![cheks][checks-src]][checks-href]
Latest version: 0.0.42

# Nuxt Server~~less~~

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![cheks][checks-src]][checks-href]

[See Documentation](https://serverless.nuxtjs.org/)

## License

[MIT License](./LICENSE)

Copyright (c) Nuxt Team

<!-- Badges -->
[npm-version-src]: https://flat.badgen.net/npm/v/@nuxt/serverless
[npm-version-href]: https://npmjs.com/package/@nuxt/serverless
[npm-downloads-src]: https://flat.badgen.net/npm/dm/@nuxt/serverless
[npm-downloads-href]: https://npmjs.com/package/@nuxt/serverless
[checks-src]: https://flat.badgen.net/github/checks/nuxt/serverless/main
[checks-href]: https://github.com/nuxt/serverless/actions
npm package: @nuxt/sigma
Description: [![npm version][npm-version-src]][npm-version-href] [![npm downloads][npm-downloads-src]][npm-downloads-href] [![checks][checks-src]][checks-href]
Latest version: 0.0.78
Deprecated: please use @nuxt/nitro

# Nuxt Server~~less~~

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![checks][checks-src]][checks-href]

[See Documentation](https://sigma.nuxtjs.org/)

## License

[MIT License](./LICENSE)

Copyright (c) Nuxt Team

<!-- Badges -->
[npm-version-src]: https://flat.badgen.net/npm/v/@nuxt/sigma
[npm-version-href]: https://npmjs.com/package/@nuxt/sigma
[npm-downloads-src]: https://flat.badgen.net/npm/dm/@nuxt/sigma
[npm-downloads-href]: https://npmjs.com/package/@nuxt/sigma
[checks-src]: https://flat.badgen.net/github/checks/nuxt/sigma/main
[checks-href]: https://github.com/nuxt/sigma/actions
npm package: @nuxt/static
Description: The fastest way to statically export your Nuxt application
Latest version: 1.0.0
Deprecated: this feature has been moved to the core. you can directly use nuxt generate

# Nuxt Static

The fastest way to statically export your Nuxt application ⚡️

Simply run `nuxt static` for deploying your Nuxt application on [Vercel](https://vercel.com), [Netlify](https://www.netlify.com) or any CI.

## Features

- Smart re-build only if needed (ie: code changes)
- Also call `nuxt export` (or `nuxt generate` for legacy users)

## Usage

Install package:

```sh
# Using yarn
yarn add --dev @nuxt/static

# Using npm
npm i -D @nuxt/static
```

This will add a new `nuxt static` command:

```
npx nuxt static
```

This command will (re-)build project if necessary and then use `nuxt generate` or `nuxt export` based on `target` option set in `nuxt.config`.

By the first `nuxt static` run, checksum of project files will be added to `.nuxt/build.json`. When using CI/CD, you have to cache/restore `.nuxt`

### Options

You can pass extra options with `static` key in `nuxt.config`:

```js
export default {
  static: {
    ignore: [
      'docs' // ignore changes in docs to avoid re-build
    ]
  }
}
```

#### `ignore`

- Type: `string[]` or `function`

Globby patterns to ignore for snapshot. If an array is provided, it will be merged with default options, you can give a function to return an array that will remove the defaults.

You call also use the `static:ignore` hook to mutate the array (useful for modules), ex:

```js
nuxt.hook('static:ignore', (ignore) => ignore.push('content'))
```

#### `cacheDir`

- Type: `string`
- Default: `{rootDir}/node_modules/.cache/nuxt`

Overrides `buildDir`

#### `globbyOptions`

- Type: GlobbyOptions
- Default: `gitignore: true`

Additional globby options for snapshot

## Development

- Clone repostory
- Use `yarn install` to install dependencies
- Use `yarn static` to run command on test fixture

## License

[MIT License](./LICENSE)
npm package: @nuxt/test-utils
Description: Test utilities for Nuxt
Latest version: 4.0.2

# Nuxt Test Utils

[![nuxt.care health](https://img.shields.io/endpoint?url=https://nuxt.care/api/badge/test-utils)](https://nuxt.care/?search=test-utils)


🧪 [Nuxt](https://nuxt.com/) Test Utils

## Overview

Nuxt offers first-class support for e2e and unit testing of your Nuxt applications.

Nuxt Test Utils is currently powering [the tests we use on Nuxt itself](https://github.com/nuxt/nuxt/tree/main/test), as well as tests used throughout the module ecosystem.

You can find out more about how to use Nuxt Test Utils:

- in [a general overview](https://nuxt.com/docs/getting-started/testing)
- in [an in-depth guide for module authors](https://nuxt.com/docs/4.x/guide/modules/testing)

## License

[MIT](./LICENSE)
npm package: @nuxt/test-utils-nightly
Description: Test utilities for Nuxt
Latest version: 4.0.2-20260408-180932-a4bbc7f

# Nuxt Test Utils

[![nuxt.care health](https://img.shields.io/endpoint?url=https://nuxt.care/api/badge/test-utils)](https://nuxt.care/?search=test-utils)


🧪 [Nuxt](https://nuxt.com/) Test Utils

## Overview

Nuxt offers first-class support for e2e and unit testing of your Nuxt applications.

Nuxt Test Utils is currently powering [the tests we use on Nuxt itself](https://github.com/nuxt/nuxt/tree/main/test), as well as tests used throughout the module ecosystem.

You can find out more about how to use Nuxt Test Utils:

- in [a general overview](https://nuxt.com/docs/getting-started/testing)
- in [an in-depth guide for module authors](https://nuxt.com/docs/4.x/guide/modules/testing)

## License

[MIT](./LICENSE)