[{"data":1,"prerenderedAt":1216},["ShallowReactive",2],{"docs-navigation-en":3,"mdc--tctnej-key":338,"docs--en-docs-guide-og-image":351,"surround--en-docs-guide-og-image":1205,"-en-docs-guide-og-image-description":1208},[4],{"title":5,"path":6,"stem":7,"children":8,"page":113},"Docs","\u002Fen\u002Fdocs","en\u002Fdocs",[9,38,114,150,191,239],{"title":10,"path":11,"stem":12,"children":13,"category":16,"description":16,"icon":37},"Get Started","\u002Fen\u002Fdocs\u002Fgetting-started","en\u002Fdocs\u002F1.getting-started\u002F1.index",[14,19,25,31],{"title":15,"path":11,"stem":12,"category":16,"description":17,"icon":18},"Introduction",null,"Movk Nuxt Docs is a Nuxt Layer you can extend to get typography, navigation, search, SEO and AI features for a documentation site. This page explains what it suits, what is included by default and what you can turn on.","i-lucide-book-open",{"title":20,"path":21,"stem":22,"category":16,"description":23,"icon":24},"Installation","\u002Fen\u002Fdocs\u002Fgetting-started\u002Finstallation","en\u002Fdocs\u002F1.getting-started\u002F2.installation","Create a documentation site from an official template, or add @movk\u002Fnuxt-docs as a layer to an existing Nuxt project. This page compares the default, i18n and module templates and lists the runtime requirements and required dependencies.","i-lucide-download",{"title":26,"path":27,"stem":28,"category":16,"description":29,"icon":30},"Project Structure","\u002Fen\u002Fdocs\u002Fgetting-started\u002Fproject-structure","en\u002Fdocs\u002F1.getting-started\u002F3.project-structure","What each directory and file does in a Movk Nuxt Docs project, where content goes, how routes are generated, which files turn into the releases and showcase pages, and what the two config files control.","i-lucide-folder-tree",{"title":32,"path":33,"stem":34,"category":16,"description":35,"icon":36},"Migrating from v2","\u002Fen\u002Fdocs\u002Fgetting-started\u002Fmigration","en\u002Fdocs\u002F1.getting-started\u002F4.migration","Every breaking change when upgrading @movk\u002Fnuxt-docs from v2 to v3, each with a v2 and v3 comparison. Work through dependencies and feature flags, content paths, config fields, visual defaults and component overrides in order to finish the upgrade.","i-lucide-arrow-right-left","i-lucide-square-play",{"title":39,"category":16,"description":16,"icon":40,"path":41,"stem":42,"children":43,"page":113},"Guide","i-lucide-compass","\u002Fen\u002Fdocs\u002Fguide","en\u002Fdocs\u002F2.guide",[44,51,58,64,70,76,82,89,95,101,107],{"title":45,"path":46,"stem":47,"category":48,"description":49,"icon":50},"Configuration Overview","\u002Fen\u002Fdocs\u002Fguide\u002Fconfiguration","en\u002Fdocs\u002F2.guide\u002F1.configuration","basics","Movk Nuxt Docs is configured in two places. nuxt.config.ts decides at build time which modules and features are included; app.config.ts controls UI, text and navigation at runtime. This page explains the split, when each takes effect, and where common changes belong.","i-lucide-settings",{"title":52,"path":53,"stem":54,"category":55,"description":56,"icon":57},"Troubleshooting","\u002Fen\u002Fdocs\u002Fguide\u002Ftroubleshooting","en\u002Fdocs\u002F2.guide\u002F10.troubleshooting","shipping","Fix common build and runtime errors involving optional dependencies, AI Chat and MCP, docs 404s, i18n configuration, pnpm build approvals and commit history.","i-lucide-life-buoy",{"title":59,"path":60,"stem":61,"category":55,"description":62,"icon":63},"FAQ","\u002Fen\u002Fdocs\u002Fguide\u002Ffaq","en\u002Fdocs\u002F2.guide\u002F11.faq","Answers to common questions about Movk Nuxt Docs, from how it relates to the Nuxt UI docs template, package managers and Node.js versions, and single-language sites, to turning off GitHub, using other AI providers, upgrading, overriding components and static hosting limits.","i-lucide-circle-help",{"title":65,"path":66,"stem":67,"category":48,"description":68,"icon":69},"Theme & Fonts","\u002Fen\u002Fdocs\u002Fguide\u002Ftheme","en\u002Fdocs\u002F2.guide\u002F2.theme","The default theme is editorial - a warm paper background, a vermilion accent, serif headings and monospaced metadata. This page covers the default colors and fonts, switching colors and heading fonts in app.config, adding a CJK serif font, the visitor theme picker and motion preferences.","i-lucide-palette",{"title":71,"path":72,"stem":73,"category":48,"description":74,"icon":75},"Navigation & Categories","\u002Fen\u002Fdocs\u002Fguide\u002Fnavigation","en\u002Fdocs\u002F2.guide\u002F3.navigation","Header links, the mobile menu and sidebar groups are declared in app.config, while the docs directory structure drives the section bar and the sidebar order. This page covers where each navigation comes from, localized labels and link prefixes, sidebar grouping rules, the sidebar filter and ⌘K search.","i-lucide-map",{"title":77,"path":78,"stem":79,"category":48,"description":80,"icon":81},"Feature Flags","\u002Fen\u002Fdocs\u002Fguide\u002Ffeatures","en\u002Fdocs\u002F2.guide\u002F4.features","Optional features such as component docs, Mermaid, AI Chat and accessibility checks are controlled by switches in nuxt.config, and features that are off bundle none of their dependencies. This page lists each flag's default, the dependencies to install when enabling it, and what happens when it is off.","i-lucide-toggle-right",{"title":83,"path":84,"stem":85,"category":86,"description":87,"icon":88},"Customization","\u002Fen\u002Fdocs\u002Fguide\u002Fcustomization","en\u002Fdocs\u002F2.guide\u002F5.customization","customization","Create a Vue file with the same name as a built-in component in your component directory to replace the header, sidebars, footer and other UI regions. This page lists the components v3 promises to keep stable, where each is mounted, and a minimal override for every one of them.","i-lucide-paintbrush",{"title":90,"path":91,"stem":92,"category":86,"description":93,"icon":94},"Pages & Layouts","\u002Fen\u002Fdocs\u002Fguide\u002Fpages","en\u002Fdocs\u002F2.guide\u002F6.pages","Besides docs pages, the layer generates the landing page, a releases page and a showcase page from files in the content directory, and you can write any Vue page in app\u002Fpages. This page covers when each built-in route is generated and its content format, header and footer switches for custom pages, and the built-in layouts.","i-lucide-layout-panel-top",{"title":96,"path":97,"stem":98,"category":86,"description":99,"icon":100},"Internationalization","\u002Fen\u002Fdocs\u002Fguide\u002Fi18n","en\u002Fdocs\u002F2.guide\u002F7.i18n","Turn on multiple languages with @nuxtjs\u002Fi18n. This page covers installation, the content directory layout, per-locale collections, UI text overrides and hreflang SEO. Without it the site stays single-language, and you can still switch the UI language.","i-lucide-languages",{"title":102,"path":103,"stem":104,"category":86,"description":105,"icon":106},"OG Images","\u002Fen\u002Fdocs\u002Fguide\u002Fog-image","en\u002Fdocs\u002F2.guide\u002F8.og-image","Every docs page gets a social sharing image (OG image) generated at build time. This page covers the fields the built-in template reads, generating images for custom pages, replacing the template, and what happens when the feature is off.","i-lucide-image",{"title":108,"path":109,"stem":110,"category":55,"description":111,"icon":112},"Deployment","\u002Fen\u002Fdocs\u002Fguide\u002Fdeployment","en\u002Fdocs\u002F2.guide\u002F9.deployment","Deploy the docs site to Vercel, Netlify, Cloudflare or any Node.js server, or generate a fully static site. This page lists the build commands, environment variables, per-platform notes and the features that are unavailable on static hosting.","i-lucide-rocket",false,{"title":115,"category":16,"description":16,"icon":116,"path":117,"stem":118,"children":119,"page":113},"AI","i-lucide-sparkles","\u002Fen\u002Fdocs\u002Fai","en\u002Fdocs\u002F3.ai",[120,126,132,138,144],{"title":121,"path":122,"stem":123,"category":16,"description":124,"icon":125},"AI Chat","\u002Fen\u002Fdocs\u002Fai\u002Fai-chat","en\u002Fdocs\u002F3.ai\u002F1.ai-chat","Turn on the built-in AI assistant for your docs site. Covers the enable conditions and dependencies, model and endpoint routing, adding other providers, and the component and composable API, so readers can ask the docs directly within minutes.","i-lucide-bot",{"title":127,"path":128,"stem":129,"category":16,"description":130,"icon":131},"MCP Server","\u002Fen\u002Fdocs\u002Fai\u002Fmcp","en\u002Fdocs\u002F3.ai\u002F2.mcp","Every docs site serves a Model Context Protocol server at \u002Fmcp by default. This page lists the built-in tools, resources and prompts, shows how to connect Claude Code, Cursor, VS Code and other clients, and explains how to disable, restrict or extend the server.","i-lucide-plug",{"title":133,"path":134,"stem":135,"category":16,"description":136,"icon":137},"Agent Skills","\u002Fen\u002Fdocs\u002Fai\u002Fskills","en\u002Fdocs\u002F3.ai\u002F3.skills","Publish the Agent Skills in your project's skills\u002F directory under \u002F.well-known\u002Fskills\u002F together with the docs site, so readers install them into Claude Code, Cursor and other assistants with one command. Covers layout, naming, publishing and the two built-in skills.","i-lucide-wand-sparkles",{"title":139,"path":140,"stem":141,"category":16,"description":142,"icon":143},"llms.txt","\u002Fen\u002Fdocs\u002Fai\u002Fllms-txt","en\u002Fdocs\u002F3.ai\u002F4.llms-txt","The docs site generates \u002Fllms.txt and \u002Fllms-full.txt automatically, giving language models an index and the full text of your docs. Learn where the defaults come from, how to set titles and sections, how they relate to each page's Markdown, and how to use them in Cursor and other tools.","i-lucide-file-text",{"title":145,"path":146,"stem":147,"category":16,"description":148,"icon":149},"Agent Discovery","\u002Fen\u002Fdocs\u002Fai\u002Fagent-discovery","en\u002Fdocs\u002F3.ai\u002F5.agent-discovery","The docs site serves AI agents a Markdown version of every page, a Markdown sitemap and a set of \u002F.well-known discovery documents, so agents can find and read content without parsing HTML. This page lists every endpoint, the negotiation rules and what the layer adds.","i-lucide-radar",{"title":151,"category":16,"description":16,"icon":152,"path":153,"stem":154,"children":155,"page":113},"Writing","i-lucide-square-pilcrow","\u002Fen\u002Fdocs\u002Fwriting","en\u002Fdocs\u002F4.writing",[156,162,168,174,179,185],{"title":157,"path":158,"stem":159,"category":16,"description":160,"icon":161},"Markdown Syntax","\u002Fen\u002Fdocs\u002Fwriting\u002Fmarkdown-syntax","en\u002Fdocs\u002F4.writing\u002F1.markdown-syntax","Docs pages are written in standard Markdown. Headings drive the table of contents and anchors, while emphasis, links, lists, tables and blockquotes structure the content. This page lists the common syntax and how Movk Nuxt Docs renders it.","i-lucide-heading",{"title":163,"path":164,"stem":165,"category":16,"description":166,"icon":167},"Code Blocks","\u002Fen\u002Fdocs\u002Fwriting\u002Fcode-blocks","en\u002Fdocs\u002F4.writing\u002F2.code-blocks","Code blocks are highlighted with github-light \u002F github-dark and support filenames, line highlights, a copy button, and color and icon previews. Use code-group, code-tree, code-preview and code-collapse for multi-file, multi-package-manager and long examples.","i-lucide-square-code",{"title":169,"path":170,"stem":171,"category":16,"description":172,"icon":173},"MDC Components","\u002Fen\u002Fdocs\u002Fwriting\u002Fmdc-components","en\u002Fdocs\u002F4.writing\u002F3.mdc-components","Embed Nuxt UI prose components in Markdown with MDC syntax, including callouts, badges, cards, accordions, tabs, steps, fields, icons and keyboard keys, to structure richer docs without writing Vue code.","i-lucide-puzzle",{"title":175,"path":176,"stem":177,"category":16,"description":178,"icon":106},"Images and Video","\u002Fen\u002Fdocs\u002Fwriting\u002Fmedia","en\u002Fdocs\u002F4.writing\u002F4.media","Insert remote or local images with Markdown image syntax, provide separate light and dark screenshots with `u-color-mode-image`, and embed videos with `:video`. Also covers where to put images and how to write alt text.",{"title":180,"path":181,"stem":182,"category":16,"description":183,"icon":184},"Mermaid Diagrams","\u002Fen\u002Fdocs\u002Fwriting\u002Fmermaid","en\u002Fdocs\u002F4.writing\u002F5.mermaid","With `movkNuxtDocs.mermaid` enabled and mermaid and dompurify installed, code blocks in the `mermaid` language render as flowcharts, sequence diagrams, class diagrams and more. Diagrams follow the color mode, load when scrolled into view and support copy and fullscreen.","i-lucide-workflow",{"title":186,"path":187,"stem":188,"category":16,"description":189,"icon":190},"Content Components","\u002Fen\u002Fdocs\u002Fwriting\u002Fcontent-components","en\u002Fdocs\u002F4.writing\u002F6.content-components","Content components the layer adds on top of Nuxt UI prose. Motion adds entrance animations, StarsBg lays an animated star field behind a section, and LandingCover, LandingSection and friends build an editorial landing page. All work directly in Markdown.","i-lucide-sparkle",{"title":192,"category":16,"description":16,"icon":193,"path":194,"stem":195,"children":196,"page":113},"Components","i-lucide-component","\u002Fen\u002Fdocs\u002Fcomponents","en\u002Fdocs\u002F5.components",[197,203,209,215,221,227,233],{"title":198,"path":199,"stem":200,"category":16,"description":201,"icon":202},"ComponentProps","\u002Fen\u002Fdocs\u002Fcomponents\u002Fcomponent-props","en\u002Fdocs\u002F5.components\u002F1.component-props","Generate a props table for a Vue component with a single `:component-props` line. Names, defaults, types and JSDoc descriptions come from nuxt-component-meta, so the docs stay in sync with the component.","i-lucide-list",{"title":204,"path":205,"stem":206,"category":16,"description":207,"icon":208},"ComponentSlots","\u002Fen\u002Fdocs\u002Fcomponents\u002Fcomponent-slots","en\u002Fdocs\u002F5.components\u002F2.component-slots","List every slot of a Vue component with a single `:component-slots` line. Slot names, scoped parameter types and JSDoc descriptions come from the `defineSlots` type, so there is nothing to write by hand.","i-lucide-layout-panel-left",{"title":210,"path":211,"stem":212,"category":16,"description":213,"icon":214},"ComponentEmits","\u002Fen\u002Fdocs\u002Fcomponents\u002Fcomponent-emits","en\u002Fdocs\u002F5.components\u002F3.component-emits","List every event of a Vue component with a single `:component-emits` line. Event names, parameter signatures and JSDoc descriptions come from the `defineEmits` type and complete the API docs next to the props and slots tables.","i-lucide-radio-tower",{"title":216,"path":217,"stem":218,"category":16,"description":219,"icon":220},"ComponentExample","\u002Fen\u002Fdocs\u002Fcomponents\u002Fcomponent-example","en\u002Fdocs\u002F5.components\u002F4.component-example","Render a Vue file from the examples directory as a live preview with its highlighted source below. Supports line highlights, collapsing, adjustable options and client-only rendering for showing components in realistic compositions.","i-lucide-app-window",{"title":222,"path":223,"stem":224,"category":16,"description":225,"icon":226},"ComponentCode","\u002Fen\u002Fdocs\u002Fcomponents\u002Fcomponent-code","en\u002Fdocs\u002F5.components\u002F5.component-code","Drive any registered Vue component from a props matrix with `::component-code`. Readers switch prop values above the live preview and the Vue snippet below updates in sync, ready to copy.","i-lucide-sliders-horizontal",{"title":228,"path":229,"stem":230,"category":16,"description":231,"icon":232},"CommitChangelog","\u002Fen\u002Fdocs\u002Fcomponents\u002Fcommit-changelog","en\u002Fdocs\u002F5.components\u002F6.commit-changelog","Fetch the GitHub commit history of a component or source file with `:commit-changelog` and show it as a timeline grouped by release. The file path is inferred from the name and can be tuned by directory, extension, casing and author, or cover several files.","i-lucide-git-commit-horizontal",{"title":234,"path":235,"stem":236,"category":16,"description":237,"icon":238},"PageLastCommit","\u002Fen\u002Fdocs\u002Fcomponents\u002Fpage-last-commit","en\u002Fdocs\u002F5.components\u002F7.page-last-commit","The meta row below the lead of every docs page shows the latest commit of its Markdown file, with time, author and message. This page covers when it appears, date formatting and author detection for PR squash merges.","i-lucide-history",{"title":240,"category":16,"description":16,"icon":241,"path":242,"stem":243,"children":244,"page":113},"Reference","i-lucide-book-marked","\u002Fen\u002Fdocs\u002Freference","en\u002Fdocs\u002F6.reference",[245,251,257,332],{"title":246,"path":247,"stem":248,"category":16,"description":249,"icon":250},"app.config Reference","\u002Fen\u002Fdocs\u002Freference\u002Fapp-config","en\u002Fdocs\u002F6.reference\u002F1.app-config","Every field of app.config.ts with its type, default value and description, generated from the layer's nuxt.schema.ts so it always matches the published version. Follow the links to the guides for usage details.","i-lucide-file-cog",{"title":252,"path":253,"stem":254,"category":16,"description":255,"icon":256},"nuxt.config Options","\u002Fen\u002Fdocs\u002Freference\u002Fnuxt-config","en\u002Fdocs\u002F6.reference\u002F2.nuxt-config","Every nuxt.config option and environment variable the layer reads at build time, including feature flags, AI Chat, component metadata, MCP, llms.txt, agent discovery and site info. Changing these options requires a rebuild or a dev server restart.","i-lucide-settings-2",{"title":258,"category":16,"description":16,"icon":259,"path":260,"stem":261,"children":262,"page":113},"Composables","i-lucide-square-function","\u002Fen\u002Fdocs\u002Freference\u002Fcomposables","en\u002Fdocs\u002F6.reference\u002F3.composables",[263,268,274,280,286,292,298,304,310,315,321,327],{"title":264,"path":265,"stem":266,"category":16,"description":267,"icon":100},"useMovkI18n","\u002Fen\u002Fdocs\u002Freference\u002Fcomposables\u002Fuse-movk-i18n","en\u002Fdocs\u002F6.reference\u002F3.composables\u002F1.use-movk-i18n","A single i18n entry point that works the same whether or not @nuxtjs\u002Fi18n is enabled. Read the current locale, translate built-in strings, build locale-prefixed links, and get the content collection and docs root for the current locale.",{"title":269,"path":270,"stem":271,"category":16,"description":272,"icon":273},"useLocaleSeo","\u002Fen\u002Fdocs\u002Freference\u002Fcomposables\u002Fuse-locale-seo","en\u002Fdocs\u002F6.reference\u002F3.composables\u002F10.use-locale-seo","Inject hreflang alternate links, x-default and og:locale on multilingual sites so search engines can tell the language versions apart. The layer's app.vue already calls it globally; call it yourself only when you rewrite app.vue.","i-lucide-globe",{"title":275,"path":276,"stem":277,"category":16,"description":278,"icon":279},"useFetchComponentMeta","\u002Fen\u002Fdocs\u002Freference\u002Fcomposables\u002Fuse-fetch-component-meta","en\u002Fdocs\u002F6.reference\u002F3.composables\u002F11.use-fetch-component-meta","Read the component metadata generated by nuxt-component-meta, including the types and descriptions of props, slots and events. ComponentProps and the other component docs components are built on it; call it directly to render your own API tables. Available only with component docs enabled.","i-lucide-braces",{"title":281,"path":282,"stem":283,"category":16,"description":284,"icon":285},"useFetchComponentExample","\u002Fen\u002Fdocs\u002Freference\u002Fcomposables\u002Fuse-fetch-component-example","en\u002Fdocs\u002F6.reference\u002F3.composables\u002F12.use-fetch-component-example","Read the source code, file path and name of example components under components\u002Fcontent\u002Fexamples. ComponentExample uses it to show example code; call it directly to display example source in your own components. Available only with component docs enabled.","i-lucide-file-code",{"title":287,"path":288,"stem":289,"category":16,"description":290,"icon":291},"useDocsNavigation","\u002Fen\u002Fdocs\u002Freference\u002Fcomposables\u002Fuse-docs-navigation","en\u002Fdocs\u002F6.reference\u002F3.composables\u002F2.use-docs-navigation","Read the docs navigation tree that the shell has already loaded. The header section bar, sidebar and docs pages all take their navigation from here, so custom components reuse the same data without querying the collection again.","i-lucide-list-tree",{"title":293,"path":294,"stem":295,"category":16,"description":296,"icon":297},"useNavigation","\u002Fen\u002Fdocs\u002Freference\u002Fcomposables\u002Fuse-navigation","en\u002Fdocs\u002F6.reference\u002F3.composables\u002F3.use-navigation","Shape the docs navigation tree for the sidebar - top-level sections, the current section's pages grouped by docs.categories, and breadcrumbs for any path. Use it in a custom sidebar or table of contents to keep the default grouping rules.","i-lucide-panel-left",{"title":299,"path":300,"stem":301,"category":16,"description":302,"icon":303},"useHeader","\u002Fen\u002Fdocs\u002Freference\u002Fcomposables\u002Fuse-header","en\u002Fdocs\u002F6.reference\u002F3.composables\u002F4.use-header","Provides the desktop and mobile header navigation links. Declare them in header.nav and header.mobileNav in app.config; override the composable with a same-named file in your project only when links must be generated from runtime state.","i-lucide-panel-top",{"title":305,"path":306,"stem":307,"category":16,"description":308,"icon":309},"useCategory","\u002Fen\u002Fdocs\u002Freference\u002Fcomposables\u002Fuse-category","en\u002Fdocs\u002F6.reference\u002F3.composables\u002F5.use-category","Provides the sidebar category definitions that decide how pages with a category are grouped and ordered within a section. Declare them in docs.categories in app.config; override the composable in your project only when categories must be computed at runtime.","i-lucide-folders",{"title":311,"path":312,"stem":313,"category":16,"description":314,"icon":69},"useTheme","\u002Fen\u002Fdocs\u002Freference\u002Fcomposables\u002Fuse-theme","en\u002Fdocs\u002F6.reference\u002F3.composables\u002F6.use-theme","The state and actions behind the theme picker - primary color, neutral color, radius, icon set, black as primary and color mode. Visitor choices persist in localStorage and can be exported as app.config or CSS. Use it for a custom theme picker or to switch themes from a page.",{"title":316,"path":317,"stem":318,"category":16,"description":319,"icon":320},"useDocsRoute","\u002Fen\u002Fdocs\u002Freference\u002Fcomposables\u002Fuse-docs-route","en\u002Fdocs\u002F6.reference\u002F3.composables\u002F7.use-docs-route","Check whether the current route is a docs page, covering \u002Fdocs\u002F* for the default locale and \u002F{locale}\u002Fdocs\u002F* for others. Use it in site-wide components such as a custom header or footer that should show something only on docs pages.","i-lucide-route",{"title":322,"path":323,"stem":324,"category":16,"description":325,"icon":326},"useDocsFilterConfig","\u002Fen\u002Fdocs\u002Freference\u002Fcomposables\u002Fuse-docs-filter-config","en\u002Fdocs\u002F6.reference\u002F3.composables\u002F8.use-docs-filter-config","Config, visibility check and filter function behind the sidebar navigation filter, mapped to aside.filter in app.config. Use them in a custom sidebar top or sidebar body component to keep the default filtering behavior.","i-lucide-list-filter",{"title":328,"path":329,"stem":330,"category":16,"description":331,"icon":220},"useDocsShell","\u002Fen\u002Fdocs\u002Freference\u002Fcomposables\u002Fuse-docs-shell","en\u002Fdocs\u002F6.reference\u002F3.composables\u002F9.use-docs-shell","The site shell shared by app.vue and error.vue. It loads the navigation tree and search index for the current locale, sets the html language, direction, font and grain attributes, and provides navigation to the component tree. Call it directly only when you rewrite app.vue or error.vue.",{"title":333,"path":334,"stem":335,"category":16,"description":336,"icon":337},"A–Z Index","\u002Fen\u002Fdocs\u002Freference\u002Fa-z","en\u002Fdocs\u002F6.reference\u002F9.a-z","Every documentation page listed alphabetically by title. Use it when you remember the name of a feature but not which section it lives in.","i-lucide-list-ordered",{"data":339,"body":340},{},{"type":341,"children":342},"root",[343],{"type":344,"tag":345,"props":346,"children":347},"element","p",{},[348],{"type":349,"value":350},"text","Copyright © 2024 - 2026",{"id":352,"title":102,"body":353,"category":86,"description":105,"difficulty":16,"extension":1198,"index":113,"keywords":16,"links":16,"meta":1199,"navigation":1200,"path":103,"requires":16,"seo":1201,"sitemap":1203,"stem":104,"__hash__":1204},"docs_en\u002Fen\u002Fdocs\u002F2.guide\u002F8.og-image.md",{"type":354,"value":355,"toc":1191},"minimark",[356,361,372,405,415,419,429,584,587,640,648,652,671,843,847,858,1097,1108,1120,1124,1131,1175,1187],[357,358,360],"h2",{"id":359},"how-it-works","How it works",[345,362,363,364,371],{},"OG images are provided by ",[365,366,370],"a",{"href":367,"rel":368},"https:\u002F\u002Fgithub.com\u002Fnuxt-modules\u002Fog-image",[369],"nofollow","nuxt-og-image",". The feature is on by default and its dependencies ship with the layer, so nothing extra is needed.",[373,374,375,392,399],"ul",{},[376,377,378,379,383,384,387,388,391],"li",{},"Docs pages, the home page, the releases page and the showcase page all call the built-in ",[380,381,382],"code",{},"NuxtSeo.takumi"," template and set ",[380,385,386],{},"og:image"," and ",[380,389,390],{},"twitter:image",";",[376,393,394,395,398],{},"The layer enables ",[380,396,397],{},"ogImage.zeroRuntime",": images are rendered to static files by the Takumi renderer during prerendering and never generated on the fly in production, so only prerendered pages have OG images;",[376,400,401,404],{},[380,402,403],{},"ogImage.buildCache"," is enabled, so images are cached on disk and later builds reuse the results for unchanged pages.",[406,407],"u-color-mode-image",{"alt":408,"className":409,"dark":413,"light":414},"OG image generated for a docs page",[410,411,412],"rounded-md","border","border-default","\u002Fscreenshots\u002Fog-image-dark.png","\u002Fscreenshots\u002Fog-image-light.png",[357,416,418],{"id":417},"template-fields","Template fields",[345,420,421,422,424,425,428],{},"The built-in ",[380,423,382],{}," template lives in ",[380,426,427],{},"layer\u002Fapp\u002Fcomponents\u002FOgImage\u002FNuxtSeo.takumi.vue"," and accepts these props:",[430,431,432,451],"table",{},[433,434,435],"thead",{},[436,437,438,442,445,448],"tr",{},[439,440,441],"th",{},"Prop",[439,443,444],{},"Type",[439,446,447],{},"Default",[439,449,450],{},"Description",[452,453,454,475,492,508,528,545,565],"tbody",{},[436,455,456,462,467,472],{},[457,458,459],"td",{},[380,460,461],{},"title",[457,463,464],{},[380,465,466],{},"string",[457,468,469],{},[380,470,471],{},"'title'",[457,473,474],{},"Main title, up to three lines",[436,476,477,482,486,489],{},[457,478,479],{},[380,480,481],{},"description",[457,483,484],{},[380,485,466],{},[457,487,488],{},"-",[457,490,491],{},"Text below the title",[436,493,494,499,503,505],{},[457,495,496],{},[380,497,498],{},"siteName",[457,500,501],{},[380,502,466],{},[457,504,488],{},[457,506,507],{},"Site name at the top",[436,509,510,515,520,525],{},[457,511,512],{},[380,513,514],{},"colorMode",[457,516,517],{},[380,518,519],{},"'light' | 'dark'",[457,521,522],{},[380,523,524],{},"'light'",[457,526,527],{},"Color scheme",[436,529,530,535,540,542],{},[457,531,532],{},[380,533,534],{},"isPro",[457,536,537],{},[380,538,539],{},"boolean",[457,541,488],{},[457,543,544],{},"Switch to a purple accent",[436,546,547,552,557,562],{},[457,548,549],{},[380,550,551],{},"width",[457,553,554],{},[380,555,556],{},"number",[457,558,559],{},[380,560,561],{},"1200",[457,563,564],{},"Image width",[436,566,567,572,576,581],{},[457,568,569],{},[380,570,571],{},"height",[457,573,574],{},[380,575,556],{},[457,577,578],{},[380,579,580],{},"600",[457,582,583],{},"Image height",[345,585,586],{},"Docs pages fill these fields from the page frontmatter:",[430,588,589,599],{},[433,590,591],{},[436,592,593,596],{},[439,594,595],{},"Field",[439,597,598],{},"Value",[452,600,601,615,628],{},[436,602,603,607],{},[457,604,605],{},[380,606,461],{},[457,608,609,612,613],{},[380,610,611],{},"seo.title",", falling back to ",[380,614,461],{},[436,616,617,621],{},[457,618,619],{},[380,620,481],{},[457,622,623,612,626],{},[380,624,625],{},"seo.description",[380,627,481],{},[436,629,630,634],{},[457,631,632],{},[380,633,498],{},[457,635,636,639],{},[380,637,638],{},"site.name"," from the site config",[345,641,642,643,387,645,647],{},"Set ",[380,644,611],{},[380,646,625],{}," in the frontmatter, and the sharing image and search results use the same title and description.",[357,649,651],{"id":650},"custom-pages","Custom pages",[345,653,654,655,658,659,662,663,666,667,670],{},"For custom Vue pages under ",[380,656,657],{},"app\u002Fpages\u002F",", call ",[380,660,661],{},"defineOgImage"," inside an ",[380,664,665],{},"import.meta.server"," branch. Link to the page from a prerendered page so the crawler can discover it, or add its path to ",[380,668,669],{},"nitro.prerender.routes",".",[672,673,679],"pre",{"className":674,"code":675,"filename":676,"language":677,"meta":678,"style":678},"language-vue shiki shiki-themes github-light github-light github-dark","\u003Cscript setup lang=\"ts\">\nconst title = 'Showcase'\nconst description = 'Docs sites built with Movk Nuxt Docs'\n\nuseSeoMeta({ title, description })\n\nif (import.meta.server) {\n  defineOgImage('NuxtSeo.takumi', {\n    title,\n    description,\n    siteName: useSiteConfig().name\n  })\n}\n\u003C\u002Fscript>\n","app\u002Fpages\u002Fshowcase.vue","vue","",[380,680,681,711,728,741,748,757,762,782,797,803,809,821,827,833],{"__ignoreMap":678},[682,683,686,690,694,698,701,704,708],"span",{"class":684,"line":685},"line",1,[682,687,689],{"class":688},"sxrX7","\u003C",[682,691,693],{"class":692},"sovSZ","script",[682,695,697],{"class":696},"snPdu"," setup",[682,699,700],{"class":696}," lang",[682,702,703],{"class":688},"=",[682,705,707],{"class":706},"sIIMD","\"ts\"",[682,709,710],{"class":688},">\n",[682,712,714,718,722,725],{"class":684,"line":713},2,[682,715,717],{"class":716},"s8jYJ","const",[682,719,721],{"class":720},"sBjJW"," title",[682,723,724],{"class":716}," =",[682,726,727],{"class":706}," 'Showcase'\n",[682,729,731,733,736,738],{"class":684,"line":730},3,[682,732,717],{"class":716},[682,734,735],{"class":720}," description",[682,737,724],{"class":716},[682,739,740],{"class":706}," 'Docs sites built with Movk Nuxt Docs'\n",[682,742,744],{"class":684,"line":743},4,[682,745,747],{"emptyLinePlaceholder":746},true,"\n",[682,749,751,754],{"class":684,"line":750},5,[682,752,753],{"class":696},"useSeoMeta",[682,755,756],{"class":688},"({ title, description })\n",[682,758,760],{"class":684,"line":759},6,[682,761,747],{"emptyLinePlaceholder":746},[682,763,765,768,771,774,776,779],{"class":684,"line":764},7,[682,766,767],{"class":716},"if",[682,769,770],{"class":688}," (",[682,772,773],{"class":716},"import",[682,775,670],{"class":688},[682,777,778],{"class":720},"meta",[682,780,781],{"class":688},".server) {\n",[682,783,785,788,791,794],{"class":684,"line":784},8,[682,786,787],{"class":696},"  defineOgImage",[682,789,790],{"class":688},"(",[682,792,793],{"class":706},"'NuxtSeo.takumi'",[682,795,796],{"class":688},", {\n",[682,798,800],{"class":684,"line":799},9,[682,801,802],{"class":688},"    title,\n",[682,804,806],{"class":684,"line":805},10,[682,807,808],{"class":688},"    description,\n",[682,810,812,815,818],{"class":684,"line":811},11,[682,813,814],{"class":688},"    siteName: ",[682,816,817],{"class":696},"useSiteConfig",[682,819,820],{"class":688},"().name\n",[682,822,824],{"class":684,"line":823},12,[682,825,826],{"class":688},"  })\n",[682,828,830],{"class":684,"line":829},13,[682,831,832],{"class":688},"}\n",[682,834,836,839,841],{"class":684,"line":835},14,[682,837,838],{"class":688},"\u003C\u002F",[682,840,693],{"class":692},[682,842,710],{"class":688},[357,844,846],{"id":845},"replace-the-template","Replace the template",[345,848,849,850,853,854,857],{},"The template is a regular component. Create a file with the same name, ",[380,851,852],{},"NuxtSeo.takumi.vue",", under ",[380,855,856],{},"app\u002Fcomponents\u002FOgImage\u002F"," in your project to override the layer's implementation; every page then uses the new template:",[672,859,862],{"className":674,"code":860,"filename":861,"language":677,"meta":678,"style":678},"\u003Cscript setup lang=\"ts\">\ndefineProps\u003C{\n  title?: string\n  description?: string\n  siteName?: string\n}>()\n\u003C\u002Fscript>\n\n\u003Ctemplate>\n  \u003Cdiv class=\"w-full h-full flex flex-col justify-between p-16 bg-[#f6f3ee] text-[#1a1a1a]\">\n    \u003Cspan class=\"text-[28px] tracking-[0.2em] uppercase text-[#c8392f]\">{{ siteName }}\u003C\u002Fspan>\n    \u003Cdiv class=\"flex flex-col gap-6\">\n      \u003Ch1 class=\"text-[72px] font-bold leading-tight m-0\">{{ title }}\u003C\u002Fh1>\n      \u003Cp v-if=\"description\" class=\"text-[30px] opacity-70 m-0\">{{ description }}\u003C\u002Fp>\n    \u003C\u002Fdiv>\n  \u003C\u002Fdiv>\n\u003C\u002Ftemplate>\n","app\u002Fcomponents\u002FOgImage\u002FNuxtSeo.takumi.vue",[380,863,864,880,888,900,909,918,923,931,935,944,976,1003,1018,1040,1068,1078,1088],{"__ignoreMap":678},[682,865,866,868,870,872,874,876,878],{"class":684,"line":685},[682,867,689],{"class":688},[682,869,693],{"class":692},[682,871,697],{"class":696},[682,873,700],{"class":696},[682,875,703],{"class":688},[682,877,707],{"class":706},[682,879,710],{"class":688},[682,881,882,885],{"class":684,"line":713},[682,883,884],{"class":696},"defineProps",[682,886,887],{"class":688},"\u003C{\n",[682,889,890,894,897],{"class":684,"line":730},[682,891,893],{"class":892},"sP4rz","  title",[682,895,896],{"class":716},"?:",[682,898,899],{"class":720}," string\n",[682,901,902,905,907],{"class":684,"line":743},[682,903,904],{"class":892},"  description",[682,906,896],{"class":716},[682,908,899],{"class":720},[682,910,911,914,916],{"class":684,"line":750},[682,912,913],{"class":892},"  siteName",[682,915,896],{"class":716},[682,917,899],{"class":720},[682,919,920],{"class":684,"line":759},[682,921,922],{"class":688},"}>()\n",[682,924,925,927,929],{"class":684,"line":764},[682,926,838],{"class":688},[682,928,693],{"class":692},[682,930,710],{"class":688},[682,932,933],{"class":684,"line":784},[682,934,747],{"emptyLinePlaceholder":746},[682,936,937,939,942],{"class":684,"line":799},[682,938,689],{"class":688},[682,940,941],{"class":692},"template",[682,943,710],{"class":688},[682,945,946,949,952,955,957,960,964,967,971,974],{"class":684,"line":805},[682,947,948],{"class":688},"  \u003C",[682,950,951],{"class":692},"div",[682,953,954],{"class":696}," class",[682,956,703],{"class":688},[682,958,959],{"class":706},"\"w-full h-full flex flex-col justify-between p-16 bg-[",[682,961,963],{"class":962},"shiki-color-highlight sjJ5C","#f6f3ee",[682,965,966],{"class":706},"] text-[",[682,968,970],{"class":969},"shiki-color-highlight s8cOs","#1a1a1a",[682,972,973],{"class":706},"]\"",[682,975,710],{"class":688},[682,977,978,981,983,985,987,990,994,996,999,1001],{"class":684,"line":811},[682,979,980],{"class":688},"    \u003C",[682,982,682],{"class":692},[682,984,954],{"class":696},[682,986,703],{"class":688},[682,988,989],{"class":706},"\"text-[28px] tracking-[0.2em] uppercase text-[",[682,991,993],{"class":992},"shiki-color-highlight sWN0s","#c8392f",[682,995,973],{"class":706},[682,997,998],{"class":688},">{{ siteName }}\u003C\u002F",[682,1000,682],{"class":692},[682,1002,710],{"class":688},[682,1004,1005,1007,1009,1011,1013,1016],{"class":684,"line":823},[682,1006,980],{"class":688},[682,1008,951],{"class":692},[682,1010,954],{"class":696},[682,1012,703],{"class":688},[682,1014,1015],{"class":706},"\"flex flex-col gap-6\"",[682,1017,710],{"class":688},[682,1019,1020,1023,1026,1028,1030,1033,1036,1038],{"class":684,"line":829},[682,1021,1022],{"class":688},"      \u003C",[682,1024,1025],{"class":692},"h1",[682,1027,954],{"class":696},[682,1029,703],{"class":688},[682,1031,1032],{"class":706},"\"text-[72px] font-bold leading-tight m-0\"",[682,1034,1035],{"class":688},">{{ title }}\u003C\u002F",[682,1037,1025],{"class":692},[682,1039,710],{"class":688},[682,1041,1042,1044,1046,1049,1051,1054,1056,1058,1061,1064,1066],{"class":684,"line":835},[682,1043,1022],{"class":688},[682,1045,345],{"class":692},[682,1047,1048],{"class":696}," v-if",[682,1050,703],{"class":688},[682,1052,1053],{"class":706},"\"description\"",[682,1055,954],{"class":696},[682,1057,703],{"class":688},[682,1059,1060],{"class":706},"\"text-[30px] opacity-70 m-0\"",[682,1062,1063],{"class":688},">{{ description }}\u003C\u002F",[682,1065,345],{"class":692},[682,1067,710],{"class":688},[682,1069,1071,1074,1076],{"class":684,"line":1070},15,[682,1072,1073],{"class":688},"    \u003C\u002F",[682,1075,951],{"class":692},[682,1077,710],{"class":688},[682,1079,1081,1084,1086],{"class":684,"line":1080},16,[682,1082,1083],{"class":688},"  \u003C\u002F",[682,1085,951],{"class":692},[682,1087,710],{"class":688},[682,1089,1091,1093,1095],{"class":684,"line":1090},17,[682,1092,838],{"class":688},[682,1094,941],{"class":692},[682,1096,710],{"class":688},[345,1098,1099,1100,1103,1104,1107],{},"The ",[380,1101,1102],{},".takumi"," part of the file name selects the Takumi renderer, so keep that suffix. For the CSS and markup the renderer supports, follow ",[365,1105,370],{"href":367,"rel":1106},[369]," and the layer's built-in template.",[1109,1110,1111,1112,1115,1116,1119],"tip",{},"To give a single custom page a different design, create a component with another name (such as ",[380,1113,1114],{},"OgImage\u002FFeature.takumi.vue",") and call ",[380,1117,1118],{},"defineOgImage('Feature.takumi', { ... })"," on that page. Built-in pages are unaffected.",[357,1121,1123],{"id":1122},"turn-og-images-off","Turn OG images off",[345,1125,1126,1127,1130],{},"If you do not need sharing images, or want shorter builds, turn the feature off in ",[380,1128,1129],{},"nuxt.config.ts",":",[672,1132,1136],{"className":1133,"code":1134,"filename":1129,"language":1135,"meta":678,"style":678},"language-ts shiki shiki-themes github-light github-light github-dark","export default defineNuxtConfig({\n  movkNuxtDocs: {\n    ogImage: false\n  }\n})\n","ts",[380,1137,1138,1152,1157,1165,1170],{"__ignoreMap":678},[682,1139,1140,1143,1146,1149],{"class":684,"line":685},[682,1141,1142],{"class":716},"export",[682,1144,1145],{"class":716}," default",[682,1147,1148],{"class":696}," defineNuxtConfig",[682,1150,1151],{"class":688},"({\n",[682,1153,1154],{"class":684,"line":713},[682,1155,1156],{"class":688},"  movkNuxtDocs: {\n",[682,1158,1159,1162],{"class":684,"line":730},[682,1160,1161],{"class":688},"    ogImage: ",[682,1163,1164],{"class":720},"false\n",[682,1166,1167],{"class":684,"line":743},[682,1168,1169],{"class":688},"  }\n",[682,1171,1172],{"class":684,"line":750},[682,1173,1174],{"class":688},"})\n",[345,1176,1177,1178,1180,1181,1183,1184,1186],{},"With it off, ",[380,1179,370],{}," is not registered and ",[380,1182,661],{}," is replaced by a no-op: calls in the layer and in your own pages stay in place and do nothing, so there is no need to remove them or add conditions. See ",[365,1185,77],{"href":78}," for the other switches.",[1188,1189,1190],"style",{},"html pre.shiki code .sxrX7, html code.shiki .sxrX7{--shiki-light:#24292E;--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sovSZ, html code.shiki .sovSZ{--shiki-light:#22863A;--shiki-default:#22863A;--shiki-dark:#85E89D}html pre.shiki code .snPdu, html code.shiki .snPdu{--shiki-light:#6F42C1;--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sIIMD, html code.shiki .sIIMD{--shiki-light:#032F62;--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .s8jYJ, html code.shiki .s8jYJ{--shiki-light:#D73A49;--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sBjJW, html code.shiki .sBjJW{--shiki-light:#005CC5;--shiki-default:#005CC5;--shiki-dark:#79B8FF}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sP4rz, html code.shiki .sP4rz{--shiki-light:#E36209;--shiki-default:#E36209;--shiki-dark:#FFAB70}html pre.shiki code .sjJ5C, html code.shiki .sjJ5C{background-color:#f6f3ee;color:#000000;display:inline-block;padding:0 0.15em;margin:0 -0.15em;border-radius:0.2em}html pre.shiki code .s8cOs, html code.shiki .s8cOs{background-color:#1a1a1a;color:#ffffff;display:inline-block;padding:0 0.15em;margin:0 -0.15em;border-radius:0.2em}html pre.shiki code .sWN0s, html code.shiki .sWN0s{background-color:#c8392f;color:#ffffff;display:inline-block;padding:0 0.15em;margin:0 -0.15em;border-radius:0.2em}",{"title":678,"searchDepth":713,"depth":713,"links":1192},[1193,1194,1195,1196,1197],{"id":359,"depth":713,"text":360},{"id":417,"depth":713,"text":418},{"id":650,"depth":713,"text":651},{"id":845,"depth":713,"text":846},{"id":1122,"depth":713,"text":1123},"md",{},{"icon":106},{"title":102,"description":1202},"Movk Nuxt Docs renders an Open Graph image for every page at build time. Learn the template fields, custom pages, replacing the template and turning it off.",{"loc":103},"KIQDZIeXfZed3uT9mks8dLZikk58WvfuEms1jou7yHM",[1206,1207],{"title":96,"path":97,"stem":98,"description":99,"icon":100,"children":-1},{"title":108,"path":109,"stem":110,"description":111,"icon":112,"children":-1},{"data":1209,"body":1210},{},{"type":341,"children":1211},[1212],{"type":344,"tag":345,"props":1213,"children":1214},{},[1215],{"type":349,"value":105},1794996151818]