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