---
title: "Get Started"
canonical_url: "https://ionic.nuxtjs.org"
---
# Get Started

<u-page-hero orientation="horizontal">
<template v-slot:title="">

Nuxt <span style="color:var(--color-primary-500);">

Ionic

</span>
</template>

<template v-slot:description="">

Batteries-included [Ionic](https://ionicframework.com/) integration for Nuxt.

- Zero-config required
- Auto-import Ionic components, composables and icons
- Ionic Router integration
- Pre-render routes
- Mobile meta tags
- Works out of the box with [Capacitor](https://capacitorjs.com/) to build mobile apps

</template>

<template v-slot:links="">
<u-button size="xl" to="https://ionic.nuxtjs.org/get-started/introduction" trailing-icon="i-lucide-arrow-right">

Get started

</u-button>

<u-button size="xl" to="https://github.com/nuxt-modules/ionic" color="neutral" icon="simple-icons-github" variant="outline">

Star on GitHub

</u-button>
</template>

```bash [Terminal]
npx nuxi@latest module add ionic
```

</u-page-hero>

## Resources for Agents

- [API catalog: every service document this site publishes](https://ionic.nuxtjs.org/.well-known/api-catalog)
- [Sitemap (XML)](https://ionic.nuxtjs.org/sitemap.xml)
- [Sitemap (Markdown): every page on the site](https://ionic.nuxtjs.org/sitemap.md)
- [MCP server card: MCP endpoint at https://ionic.nuxtjs.org/mcp](https://ionic.nuxtjs.org/.well-known/mcp/server-card.json)
- [MCP endpoint (streamable HTTP)](https://ionic.nuxtjs.org/mcp)
- [llms.txt: index of the documentation for LLMs](https://ionic.nuxtjs.org/llms.txt)
- [llms-full.txt: the full documentation as a single file](https://ionic.nuxtjs.org/llms-full.txt)
- [OpenAPI document: every route this site serves to agents](https://ionic.nuxtjs.org/openapi.json)


## Sitemap

See the full [sitemap](https://ionic.nuxtjs.org/sitemap.md) for all pages.