An open API service indexing awesome lists of open source software.

https://github.com/harlan-zw/nuxt-seo-ui

Deprecated - Nuxt components with Schema.org and SEO integrations
https://github.com/harlan-zw/nuxt-seo-ui

Last synced: 7 months ago
JSON representation

Deprecated - Nuxt components with Schema.org and SEO integrations

Awesome Lists containing this project

README

          

nuxt-seo-ui

âš ī¸ After careful consideration, this package will no longer be developed. The core feature of this module,
`useBreadcrumbItems` will be moved to [Nuxt SEO](https://github.com/harlan-zw/nuxt-seo-kit).

---




NPM version
NPM Downloads
GitHub stars


Fully styled and customizable components for improving your Nuxt SEO.




Status: Experimental

Please report any issues 🐛

Made possible by my Sponsor Program 💖
Follow me @harlan_zw đŸĻ â€ĸ Join Discord for help


â„šī¸ Looking for a complete SEO solution? Check out [Nuxt SEO Kit](https://github.com/harlan-zw/nuxt-seo-kit).

## Components

- Breadcrumbs
- More coming soon

## Features

- Zero-config integrations with: nuxt-icon, nuxt-site-config and @nuxtjs/i18n
- Fully styled or headless, you choose
- Accessible

### Zero Config Integrations

- [`nuxt-site-config`](https://content.nuxtjs.org/guide/writing/document-driven)

Adds all entries automatically with generated `lastmod`. Images are included from any `` tags

- [`nuxt-icon`](https://github.com/harlan-zw/nuxt-simple-robots)

Render icons in the components.

- [`@nuxtjs/i18n`](https://github.com/nuxt-modules/i18n)

Translates accesibiliy labels for the language.

## Install

```bash
npm install --save-dev nuxt-seo-ui

# Using yarn
yarn add --dev nuxt-seo-ui
```

## Setup

_nuxt.config.ts_

```ts
export default defineNuxtConfig({
modules: [
'nuxt-seo-ui',
],
})
```

## Usage

## Module Config

### `enabled`

- Type: `boolean`
- Default: `undefined`

Will stop the module from running if set to false.

### `prefix`

- Type: `string`
- Default: `s`

The prefix to use for the components.
For example, setting `Seo` as the prefix will make components accessible as `SeoBreadcrumbs`.

### `global`

- Type: `boolean`
- Default: `false`

Should components be registered globally.

## Sponsors





## License

MIT License Š 2022-PRESENT [Harlan Wilton](https://github.com/harlan-zw)