[{"data":1,"prerenderedAt":814},["ShallowReactive",2],{"navigation_docs":3,"-get-started-installation":200,"-get-started-installation-surround":811},[4,30,47,187],{"title":5,"path":6,"stem":7,"children":8,"page":29},"Get Started","/get-started","1.get-started",[9,13,17,21,25],{"title":10,"path":11,"stem":12},"Installation","/get-started/installation","1.get-started/1.installation",{"title":14,"path":15,"stem":16},"Configuration","/get-started/configuration","1.get-started/2.configuration",{"title":18,"path":19,"stem":20},"Providers","/get-started/providers","1.get-started/3.providers",{"title":22,"path":23,"stem":24},"Contributing","/get-started/contributing","1.get-started/4.contributing",{"title":26,"path":27,"stem":28},"Migration","/get-started/migration","1.get-started/5.migration",false,{"title":31,"path":32,"stem":33,"children":34,"page":29},"Usage","/usage","2.usage",[35,39,43],{"title":36,"path":37,"stem":38},"\u003CNuxtImg>","/usage/nuxt-img","2.usage/1.nuxt-img",{"title":40,"path":41,"stem":42},"\u003CNuxtPicture>","/usage/nuxt-picture","2.usage/2.nuxt-picture",{"title":44,"path":45,"stem":46},"useImage()","/usage/use-image","2.usage/3.use-image",{"title":18,"path":48,"stem":49,"children":50,"page":29},"/providers","3.providers",[51,55,59,63,67,71,75,79,83,87,91,95,99,103,107,111,115,119,123,127,131,135,139,143,147,151,155,159,163,167,171,175,179,183],{"title":52,"path":53,"stem":54},"Aliyun","/providers/aliyun","3.providers/aliyun",{"title":56,"path":57,"stem":58},"AWS Amplify","/providers/aws-amplify","3.providers/aws-amplify",{"title":60,"path":61,"stem":62},"Bunny","/providers/bunny","3.providers/bunny",{"title":64,"path":65,"stem":66},"Caisy","/providers/caisy","3.providers/caisy",{"title":68,"path":69,"stem":70},"Cloudflare","/providers/cloudflare","3.providers/cloudflare",{"title":72,"path":73,"stem":74},"Cloudimage","/providers/cloudimage","3.providers/cloudimage",{"title":76,"path":77,"stem":78},"Cloudinary","/providers/cloudinary","3.providers/cloudinary",{"title":80,"path":81,"stem":82},"Contentful","/providers/contentful","3.providers/contentful",{"title":84,"path":85,"stem":86},"Directus","/providers/directus","3.providers/directus",{"title":88,"path":89,"stem":90},"Fastly","/providers/fastly","3.providers/fastly",{"title":92,"path":93,"stem":94},"Filerobot","/providers/filerobot","3.providers/filerobot",{"title":96,"path":97,"stem":98},"GitHub","/providers/github","3.providers/github",{"title":100,"path":101,"stem":102},"Glide","/providers/glide","3.providers/glide",{"title":104,"path":105,"stem":106},"Gumlet","/providers/gumlet","3.providers/gumlet",{"title":108,"path":109,"stem":110},"Hygraph","/providers/hygraph","3.providers/hygraph",{"title":112,"path":113,"stem":114},"ImageEngine","/providers/imageengine","3.providers/imageengine",{"title":116,"path":117,"stem":118},"ImageKit","/providers/imagekit","3.providers/imagekit",{"title":120,"path":121,"stem":122},"Imgix","/providers/imgix","3.providers/imgix",{"title":124,"path":125,"stem":126},"IPX","/providers/ipx","3.providers/ipx",{"title":128,"path":129,"stem":130},"Netlify","/providers/netlify","3.providers/netlify",{"title":132,"path":133,"stem":134},"None","/providers/none","3.providers/none",{"title":136,"path":137,"stem":138},"Prepr","/providers/prepr","3.providers/prepr",{"title":140,"path":141,"stem":142},"Prismic","/providers/prismic","3.providers/prismic",{"title":144,"path":145,"stem":146},"Sanity","/providers/sanity","3.providers/sanity",{"title":148,"path":149,"stem":150},"Shopify","/providers/shopify","3.providers/shopify",{"title":152,"path":153,"stem":154},"Sirv","/providers/sirv","3.providers/sirv",{"title":156,"path":157,"stem":158},"Storyblok","/providers/storyblok","3.providers/storyblok",{"title":160,"path":161,"stem":162},"Strapi","/providers/strapi","3.providers/strapi",{"title":164,"path":165,"stem":166},"Supabase","/providers/supabase","3.providers/supabase",{"title":168,"path":169,"stem":170},"Twicpics","/providers/twicpics","3.providers/twicpics",{"title":172,"path":173,"stem":174},"Unsplash","/providers/unsplash","3.providers/unsplash",{"title":176,"path":177,"stem":178},"Uploadcare","/providers/uploadcare","3.providers/uploadcare",{"title":180,"path":181,"stem":182},"Vercel","/providers/vercel","3.providers/vercel",{"title":184,"path":185,"stem":186},"Weserv","/providers/weserv","3.providers/weserv",{"title":188,"path":189,"stem":190,"children":191,"page":29},"Advanced","/advanced","4.advanced",[192,196],{"title":193,"path":194,"stem":195},"Custom Provider","/advanced/custom-provider","4.advanced/1.custom-provider",{"title":197,"path":198,"stem":199},"Static Images","/advanced/static-images","4.advanced/2.static-images",{"id":201,"title":10,"body":202,"description":804,"extension":805,"links":806,"meta":807,"navigation":808,"path":11,"seo":809,"stem":12,"__hash__":810},"docs/1.get-started/1.installation.md",{"type":203,"value":204,"toc":794},"minimark",[205,241,246,254,285,289,295,356,367,434,437,446,490,498,502,524,527,536,541,550,592,607,611,617,650,658,662,665,681,741,746,764,790],[206,207,208,209,213,214,218,219,222,223,230,231,234,235,240],"note",{},"You are reading the ",[210,211,212],"code",{},"v2"," documentation compatible with ",[215,216,217],"strong",{},"Nuxt 3.1+",". ",[220,221],"br",{}," Checkout ",[224,225,229],"a",{"href":226,"rel":227},"https://v0.image.nuxtjs.org/getting-started/installation",[228],"nofollow","v0.image.nuxtjs.org"," for ",[215,232,233],{},"Nuxt 2"," compatible version. (",[224,236,239],{"href":237,"rel":238},"https://github.com/nuxt/image/discussions/548",[228],"Announcement",").",[242,243,245],"h2",{"id":244},"automatic-installation","Automatic Installation",[247,248,249,250,253],"p",{},"To get started, add ",[210,251,252],{},"@nuxt/image"," to your project:",[255,256,261],"pre",{"className":257,"code":258,"language":259,"meta":260,"style":260},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","npx nuxt module add image\n","bash","",[210,262,263],{"__ignoreMap":260},[264,265,268,272,276,279,282],"span",{"class":266,"line":267},"line",1,[264,269,271],{"class":270},"sBMFI","npx",[264,273,275],{"class":274},"sfazB"," nuxt",[264,277,278],{"class":274}," module",[264,280,281],{"class":274}," add",[264,283,284],{"class":274}," image\n",[242,286,288],{"id":287},"manual-installation","Manual Installation",[247,290,291,292,294],{},"Add ",[210,293,252],{}," dependency to your project:",[296,297,298,314,328,342],"code-group",{},[255,299,302],{"className":257,"code":300,"filename":301,"language":259,"meta":260,"style":260},"npm i @nuxt/image\n","npm",[210,303,304],{"__ignoreMap":260},[264,305,306,308,311],{"class":266,"line":267},[264,307,301],{"class":270},[264,309,310],{"class":274}," i",[264,312,313],{"class":274}," @nuxt/image\n",[255,315,318],{"className":257,"code":316,"filename":317,"language":259,"meta":260,"style":260},"yarn add @nuxt/image\n","yarn",[210,319,320],{"__ignoreMap":260},[264,321,322,324,326],{"class":266,"line":267},[264,323,317],{"class":270},[264,325,281],{"class":274},[264,327,313],{"class":274},[255,329,332],{"className":257,"code":330,"filename":331,"language":259,"meta":260,"style":260},"pnpm add @nuxt/image\n","pnpm",[210,333,334],{"__ignoreMap":260},[264,335,336,338,340],{"class":266,"line":267},[264,337,331],{"class":270},[264,339,281],{"class":274},[264,341,313],{"class":274},[255,343,346],{"className":257,"code":344,"filename":345,"language":259,"meta":260,"style":260},"bun add @nuxt/image\n","bun",[210,347,348],{"__ignoreMap":260},[264,349,350,352,354],{"class":266,"line":267},[264,351,345],{"class":270},[264,353,281],{"class":274},[264,355,313],{"class":274},[247,357,358,359,362,363,366],{},"Then, add it to the ",[210,360,361],{},"modules"," in your ",[210,364,365],{},"nuxt.config",":",[255,368,373],{"className":369,"code":370,"filename":371,"language":372,"meta":260,"style":260},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","export default defineNuxtConfig({\n  modules: [\n    '@nuxt/image'\n  ]\n})\n","nuxt.config.ts","ts",[210,374,375,396,408,419,425],{"__ignoreMap":260},[264,376,377,381,384,388,392],{"class":266,"line":267},[264,378,380],{"class":379},"s7zQu","export",[264,382,383],{"class":379}," default",[264,385,387],{"class":386},"s2Zo4"," defineNuxtConfig",[264,389,391],{"class":390},"sTEyZ","(",[264,393,395],{"class":394},"sMK4o","{\n",[264,397,399,403,405],{"class":266,"line":398},2,[264,400,402],{"class":401},"swJcz","  modules",[264,404,366],{"class":394},[264,406,407],{"class":390}," [\n",[264,409,411,414,416],{"class":266,"line":410},3,[264,412,413],{"class":394},"    '",[264,415,252],{"class":274},[264,417,418],{"class":394},"'\n",[264,420,422],{"class":266,"line":421},4,[264,423,424],{"class":390},"  ]\n",[264,426,428,431],{"class":266,"line":427},5,[264,429,430],{"class":394},"}",[264,432,433],{"class":390},")\n",[242,435,14],{"id":436},"configuration",[247,438,439,440,443,444,366],{},"Add an ",[210,441,442],{},"image"," section in your ",[210,445,365],{},[255,447,449],{"className":369,"code":448,"filename":371,"language":372,"meta":260,"style":260},"export default defineNuxtConfig({\n  image: {\n    // Options\n  }\n})\n",[210,450,451,463,473,479,484],{"__ignoreMap":260},[264,452,453,455,457,459,461],{"class":266,"line":267},[264,454,380],{"class":379},[264,456,383],{"class":379},[264,458,387],{"class":386},[264,460,391],{"class":390},[264,462,395],{"class":394},[264,464,465,468,470],{"class":266,"line":398},[264,466,467],{"class":401},"  image",[264,469,366],{"class":394},[264,471,472],{"class":394}," {\n",[264,474,475],{"class":266,"line":410},[264,476,478],{"class":477},"sHwdD","    // Options\n",[264,480,481],{"class":266,"line":421},[264,482,483],{"class":394},"  }\n",[264,485,486,488],{"class":266,"line":427},[264,487,430],{"class":394},[264,489,433],{"class":390},[491,492,493,494,497],"tip",{},"Checkout the ",[224,495,496],{"href":15},"image configuration"," for all available options and features to customize.",[242,499,501],{"id":500},"edge-channel","Edge Channel",[247,503,504,505,508,509,511,512,515,516,523],{},"After each commit is merged into the ",[210,506,507],{},"main"," branch of ",[210,510,252],{}," and ",[215,513,514],{},"passing all tests",", we trigger an automated npm release using GitHub Actions publishing a ",[224,517,520],{"href":518,"rel":519},"https://npmjs.com/package/@nuxt/image-nightly",[228],[210,521,522],{},"@nuxt/image-nightly"," package.",[247,525,526],{},"You can opt in to use this release channel and avoid waiting for the next release and helping the module by beta testing changes.",[247,528,529,530,535],{},"The build and publishing method and quality of edge releases are the same as stable ones. The only difference is that you should often check the ",[224,531,534],{"href":532,"rel":533},"https://github.com/nuxt/image",[228],"GitHub repository"," for updates. There is a slight chance of regressions not being caught during the review process and by the automated tests. Therefore, we internally use this channel to double-check everything before each release.",[537,538,540],"h3",{"id":539},"opting-into-the-edge-channel","Opting into the edge channel",[247,542,543,544,546,547,366],{},"Update ",[210,545,252],{}," dependency inside ",[210,548,549],{},"package.json",[255,551,555],{"className":552,"code":553,"filename":549,"language":554,"meta":260,"style":260},"language-diff shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"devDependencies\": {\n-   \"@nuxt/image\": \"^1.0.0\"\n+   \"@nuxt/image\": \"npm:@nuxt/image-nightly@latest\"\n  }\n}\n","diff",[210,556,557,561,566,574,582,586],{"__ignoreMap":260},[264,558,559],{"class":266,"line":267},[264,560,395],{"class":390},[264,562,563],{"class":266,"line":398},[264,564,565],{"class":390},"  \"devDependencies\": {\n",[264,567,568,571],{"class":266,"line":410},[264,569,570],{"class":394},"-",[264,572,573],{"class":401},"   \"@nuxt/image\": \"^1.0.0\"\n",[264,575,576,579],{"class":266,"line":421},[264,577,578],{"class":394},"+",[264,580,581],{"class":274},"   \"@nuxt/image\": \"npm:@nuxt/image-nightly@latest\"\n",[264,583,584],{"class":266,"line":427},[264,585,483],{"class":390},[264,587,589],{"class":266,"line":588},6,[264,590,591],{"class":390},"}\n",[247,593,594,595,598,599,602,603,606],{},"Remove lockfile (",[210,596,597],{},"package-lock.json",", ",[210,600,601],{},"yarn.lock",", or ",[210,604,605],{},"pnpm-lock.yaml",") and reinstall dependencies.",[537,608,610],{"id":609},"opting-out-from-the-edge-channel","Opting out from the edge channel",[247,612,543,613,546,615,366],{},[210,614,252],{},[210,616,549],{},[255,618,620],{"className":552,"code":619,"filename":549,"language":554,"meta":260,"style":260},"{\n  \"devDependencies\": {\n-   \"@nuxt/image\": \"npm:@nuxt/image-nightly@latest\"\n+   \"@nuxt/image\": \"^1.0.0\"\n  }\n}\n",[210,621,622,626,630,636,642,646],{"__ignoreMap":260},[264,623,624],{"class":266,"line":267},[264,625,395],{"class":390},[264,627,628],{"class":266,"line":398},[264,629,565],{"class":390},[264,631,632,634],{"class":266,"line":410},[264,633,570],{"class":394},[264,635,581],{"class":401},[264,637,638,640],{"class":266,"line":421},[264,639,578],{"class":394},[264,641,573],{"class":274},[264,643,644],{"class":266,"line":427},[264,645,483],{"class":390},[264,647,648],{"class":266,"line":588},[264,649,591],{"class":390},[247,651,594,652,598,654,602,656,606],{},[210,653,597],{},[210,655,601],{},[210,657,605],{},[242,659,661],{"id":660},"troubleshooting","Troubleshooting",[247,663,664],{},"If an error occurs during installation:",[666,667,668,678],"ul",{},[669,670,671,672,677],"li",{},"Ensure using LTS version of NodeJS (",[224,673,676],{"href":674,"rel":675},"https://nodejs.org/en/download",[228],"NodeJS Download page",")",[669,679,680],{},"Try to upgrade to latest versions:",[682,683,684],"div",{},[296,685,686,700,714,727],{},[255,687,689],{"className":257,"code":688,"filename":301,"language":259,"meta":260,"style":260},"npm up @nuxt/image\n",[210,690,691],{"__ignoreMap":260},[264,692,693,695,698],{"class":266,"line":267},[264,694,301],{"class":270},[264,696,697],{"class":274}," up",[264,699,313],{"class":274},[255,701,703],{"className":257,"code":702,"filename":317,"language":259,"meta":260,"style":260},"yarn upgrade @nuxt/image\n",[210,704,705],{"__ignoreMap":260},[264,706,707,709,712],{"class":266,"line":267},[264,708,317],{"class":270},[264,710,711],{"class":274}," upgrade",[264,713,313],{"class":274},[255,715,717],{"className":257,"code":716,"filename":331,"language":259,"meta":260,"style":260},"pnpm up @nuxt/image\n",[210,718,719],{"__ignoreMap":260},[264,720,721,723,725],{"class":266,"line":267},[264,722,331],{"class":270},[264,724,697],{"class":274},[264,726,313],{"class":274},[255,728,730],{"className":257,"code":729,"filename":345,"language":259,"meta":260,"style":260},"bun update @nuxt/image\n",[210,731,732],{"__ignoreMap":260},[264,733,734,736,739],{"class":266,"line":267},[264,735,345],{"class":270},[264,737,738],{"class":274}," update",[264,740,313],{"class":274},[666,742,743],{},[669,744,745],{},"Try recreating lockfile:",[682,747,748],{},[255,749,751],{"className":257,"code":750,"language":259,"meta":260,"style":260},"npx nuxt upgrade --force\n",[210,752,753],{"__ignoreMap":260},[264,754,755,757,759,761],{"class":266,"line":267},[264,756,271],{"class":270},[264,758,275],{"class":274},[264,760,711],{"class":274},[264,762,763],{"class":274}," --force\n",[666,765,766,781],{},[669,767,768,769,511,772,775,776,780],{},"If there is still an error related to ",[210,770,771],{},"sharp",[210,773,774],{},"node-gyp",", it is probably because your OS architecture or NodeJS version is not included in pre-built binaries and needs to be built from source (for example, this sometimes occurs on Apple M1). Checkout ",[224,777,774],{"href":778,"rel":779},"https://github.com/nodejs/node-gyp#installation",[228]," for install requirements.",[669,782,783,784,789],{},"If none of the above worked, please ",[224,785,788],{"href":786,"rel":787},"https://github.com/nuxt/image/issues",[228],"open an issue"," and include error trace, OS, Node version and the package manager used for installing.",[791,792,793],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}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 .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}",{"title":260,"searchDepth":398,"depth":398,"links":795},[796,797,798,799,803],{"id":244,"depth":398,"text":245},{"id":287,"depth":398,"text":288},{"id":436,"depth":398,"text":14},{"id":500,"depth":398,"text":501,"children":800},[801,802],{"id":539,"depth":410,"text":540},{"id":609,"depth":410,"text":610},{"id":660,"depth":398,"text":661},"Using image module in your Nuxt project is only one command away.","md",null,{},true,{"title":10,"description":804},"gj3FQ7AexSzKWZUUTLEfdR68oaL0IlqeyKOKQhDAW_I",[806,812],{"title":14,"path":15,"stem":16,"description":813,"children":-1},"Nuxt Image is configured with sensible defaults.",1768512298992]