[{"data":1,"prerenderedAt":798},["ShallowReactive",2],{"navigation_docs":3,"-get-started-installation":184,"-get-started-installation-surround":795},[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":788,"extension":789,"layout":790,"links":790,"meta":791,"navigation":792,"path":11,"seo":793,"stem":12,"__hash__":794},"docs/1.get-started/1.installation.md",{"type":187,"value":188,"toc":778},"minimark",[189,225,230,238,269,273,279,340,351,418,421,430,474,482,486,508,511,520,525,534,576,591,595,601,634,642,646,649,665,725,730,748,774],[190,191,192,193,197,198,202,203,206,207,214,215,218,219,224],"note",{},"You are reading the ",[194,195,196],"code",{},"v1"," documentation compatible with ",[199,200,201],"strong",{},"Nuxt 3",". ",[204,205],"br",{}," Checkout ",[208,209,213],"a",{"href":210,"rel":211},"https://v0.image.nuxtjs.org/getting-started/installation",[212],"nofollow","v0.image.nuxtjs.org"," for ",[199,216,217],{},"Nuxt 2"," compatible version. (",[208,220,223],{"href":221,"rel":222},"https://github.com/nuxt/image/discussions/548",[212],"Announcement",").",[226,227,229],"h2",{"id":228},"automatic-installation","Automatic Installation",[231,232,233,234,237],"p",{},"To get started, add ",[194,235,236],{},"@nuxt/image"," to your project:",[239,240,245],"pre",{"className":241,"code":242,"language":243,"meta":244,"style":244},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","npx nuxt module add image\n","bash","",[194,246,247],{"__ignoreMap":244},[248,249,252,256,260,263,266],"span",{"class":250,"line":251},"line",1,[248,253,255],{"class":254},"sBMFI","npx",[248,257,259],{"class":258},"sfazB"," nuxt",[248,261,262],{"class":258}," module",[248,264,265],{"class":258}," add",[248,267,268],{"class":258}," image\n",[226,270,272],{"id":271},"manual-installation","Manual Installation",[231,274,275,276,278],{},"Add ",[194,277,236],{}," dependency to your project:",[280,281,282,298,312,326],"code-group",{},[239,283,286],{"className":241,"code":284,"filename":285,"language":243,"meta":244,"style":244},"npm i @nuxt/image\n","npm",[194,287,288],{"__ignoreMap":244},[248,289,290,292,295],{"class":250,"line":251},[248,291,285],{"class":254},[248,293,294],{"class":258}," i",[248,296,297],{"class":258}," @nuxt/image\n",[239,299,302],{"className":241,"code":300,"filename":301,"language":243,"meta":244,"style":244},"yarn add @nuxt/image\n","yarn",[194,303,304],{"__ignoreMap":244},[248,305,306,308,310],{"class":250,"line":251},[248,307,301],{"class":254},[248,309,265],{"class":258},[248,311,297],{"class":258},[239,313,316],{"className":241,"code":314,"filename":315,"language":243,"meta":244,"style":244},"pnpm add @nuxt/image\n","pnpm",[194,317,318],{"__ignoreMap":244},[248,319,320,322,324],{"class":250,"line":251},[248,321,315],{"class":254},[248,323,265],{"class":258},[248,325,297],{"class":258},[239,327,330],{"className":241,"code":328,"filename":329,"language":243,"meta":244,"style":244},"bun add @nuxt/image\n","bun",[194,331,332],{"__ignoreMap":244},[248,333,334,336,338],{"class":250,"line":251},[248,335,329],{"class":254},[248,337,265],{"class":258},[248,339,297],{"class":258},[231,341,342,343,346,347,350],{},"Then, add it to the ",[194,344,345],{},"modules"," in your ",[194,348,349],{},"nuxt.config",":",[239,352,357],{"className":353,"code":354,"filename":355,"language":356,"meta":244,"style":244},"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",[194,358,359,380,392,403,409],{"__ignoreMap":244},[248,360,361,365,368,372,376],{"class":250,"line":251},[248,362,364],{"class":363},"s7zQu","export",[248,366,367],{"class":363}," default",[248,369,371],{"class":370},"s2Zo4"," defineNuxtConfig",[248,373,375],{"class":374},"sTEyZ","(",[248,377,379],{"class":378},"sMK4o","{\n",[248,381,383,387,389],{"class":250,"line":382},2,[248,384,386],{"class":385},"swJcz","  modules",[248,388,350],{"class":378},[248,390,391],{"class":374}," [\n",[248,393,395,398,400],{"class":250,"line":394},3,[248,396,397],{"class":378},"    '",[248,399,236],{"class":258},[248,401,402],{"class":378},"'\n",[248,404,406],{"class":250,"line":405},4,[248,407,408],{"class":374},"  ]\n",[248,410,412,415],{"class":250,"line":411},5,[248,413,414],{"class":378},"}",[248,416,417],{"class":374},")\n",[226,419,14],{"id":420},"configuration",[231,422,423,424,427,428,350],{},"Add an ",[194,425,426],{},"image"," section in your ",[194,429,349],{},[239,431,433],{"className":353,"code":432,"filename":355,"language":356,"meta":244,"style":244},"export default defineNuxtConfig({\n  image: {\n    // Options\n  }\n})\n",[194,434,435,447,457,463,468],{"__ignoreMap":244},[248,436,437,439,441,443,445],{"class":250,"line":251},[248,438,364],{"class":363},[248,440,367],{"class":363},[248,442,371],{"class":370},[248,444,375],{"class":374},[248,446,379],{"class":378},[248,448,449,452,454],{"class":250,"line":382},[248,450,451],{"class":385},"  image",[248,453,350],{"class":378},[248,455,456],{"class":378}," {\n",[248,458,459],{"class":250,"line":394},[248,460,462],{"class":461},"sHwdD","    // Options\n",[248,464,465],{"class":250,"line":405},[248,466,467],{"class":378},"  }\n",[248,469,470,472],{"class":250,"line":411},[248,471,414],{"class":378},[248,473,417],{"class":374},[475,476,477,478,481],"tip",{},"Checkout the ",[208,479,480],{"href":15},"image configuration"," for all available options and features to customize.",[226,483,485],{"id":484},"edge-channel","Edge Channel",[231,487,488,489,492,493,495,496,499,500,507],{},"After each commit is merged into the ",[194,490,491],{},"main"," branch of ",[194,494,236],{}," and ",[199,497,498],{},"passing all tests",", we trigger an automated npm release using GitHub Actions publishing a ",[208,501,504],{"href":502,"rel":503},"https://npmjs.com/package/@nuxt/image-nightly",[212],[194,505,506],{},"@nuxt/image-nightly"," package.",[231,509,510],{},"You can opt in to use this release channel and avoid waiting for the next release and helping the module by beta testing changes.",[231,512,513,514,519],{},"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 ",[208,515,518],{"href":516,"rel":517},"https://github.com/nuxt/image",[212],"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.",[521,522,524],"h3",{"id":523},"opting-into-the-edge-channel","Opting into the edge channel",[231,526,527,528,530,531,350],{},"Update ",[194,529,236],{}," dependency inside ",[194,532,533],{},"package.json",[239,535,539],{"className":536,"code":537,"filename":533,"language":538,"meta":244,"style":244},"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",[194,540,541,545,550,558,566,570],{"__ignoreMap":244},[248,542,543],{"class":250,"line":251},[248,544,379],{"class":374},[248,546,547],{"class":250,"line":382},[248,548,549],{"class":374},"  \"devDependencies\": {\n",[248,551,552,555],{"class":250,"line":394},[248,553,554],{"class":378},"-",[248,556,557],{"class":385},"   \"@nuxt/image\": \"^1.0.0\"\n",[248,559,560,563],{"class":250,"line":405},[248,561,562],{"class":378},"+",[248,564,565],{"class":258},"   \"@nuxt/image\": \"npm:@nuxt/image-nightly@latest\"\n",[248,567,568],{"class":250,"line":411},[248,569,467],{"class":374},[248,571,573],{"class":250,"line":572},6,[248,574,575],{"class":374},"}\n",[231,577,578,579,582,583,586,587,590],{},"Remove lockfile (",[194,580,581],{},"package-lock.json",", ",[194,584,585],{},"yarn.lock",", or ",[194,588,589],{},"pnpm-lock.yaml",") and reinstall dependencies.",[521,592,594],{"id":593},"opting-out-from-the-edge-channel","Opting out from the edge channel",[231,596,527,597,530,599,350],{},[194,598,236],{},[194,600,533],{},[239,602,604],{"className":536,"code":603,"filename":533,"language":538,"meta":244,"style":244},"{\n  \"devDependencies\": {\n-   \"@nuxt/image\": \"npm:@nuxt/image-nightly@latest\"\n+   \"@nuxt/image\": \"^1.0.0\"\n  }\n}\n",[194,605,606,610,614,620,626,630],{"__ignoreMap":244},[248,607,608],{"class":250,"line":251},[248,609,379],{"class":374},[248,611,612],{"class":250,"line":382},[248,613,549],{"class":374},[248,615,616,618],{"class":250,"line":394},[248,617,554],{"class":378},[248,619,565],{"class":385},[248,621,622,624],{"class":250,"line":405},[248,623,562],{"class":378},[248,625,557],{"class":258},[248,627,628],{"class":250,"line":411},[248,629,467],{"class":374},[248,631,632],{"class":250,"line":572},[248,633,575],{"class":374},[231,635,578,636,582,638,586,640,590],{},[194,637,581],{},[194,639,585],{},[194,641,589],{},[226,643,645],{"id":644},"troubleshooting","Troubleshooting",[231,647,648],{},"If an error occurs during installation:",[650,651,652,662],"ul",{},[653,654,655,656,661],"li",{},"Ensure using LTS version of NodeJS (",[208,657,660],{"href":658,"rel":659},"https://nodejs.org/en/download",[212],"NodeJS Download page",")",[653,663,664],{},"Try to upgrade to latest versions:",[666,667,668],"div",{},[280,669,670,684,698,711],{},[239,671,673],{"className":241,"code":672,"filename":285,"language":243,"meta":244,"style":244},"npm up @nuxt/image\n",[194,674,675],{"__ignoreMap":244},[248,676,677,679,682],{"class":250,"line":251},[248,678,285],{"class":254},[248,680,681],{"class":258}," up",[248,683,297],{"class":258},[239,685,687],{"className":241,"code":686,"filename":301,"language":243,"meta":244,"style":244},"yarn upgrade @nuxt/image\n",[194,688,689],{"__ignoreMap":244},[248,690,691,693,696],{"class":250,"line":251},[248,692,301],{"class":254},[248,694,695],{"class":258}," upgrade",[248,697,297],{"class":258},[239,699,701],{"className":241,"code":700,"filename":315,"language":243,"meta":244,"style":244},"pnpm up @nuxt/image\n",[194,702,703],{"__ignoreMap":244},[248,704,705,707,709],{"class":250,"line":251},[248,706,315],{"class":254},[248,708,681],{"class":258},[248,710,297],{"class":258},[239,712,714],{"className":241,"code":713,"filename":329,"language":243,"meta":244,"style":244},"bun update @nuxt/image\n",[194,715,716],{"__ignoreMap":244},[248,717,718,720,723],{"class":250,"line":251},[248,719,329],{"class":254},[248,721,722],{"class":258}," update",[248,724,297],{"class":258},[650,726,727],{},[653,728,729],{},"Try recreating lockfile:",[666,731,732],{},[239,733,735],{"className":241,"code":734,"language":243,"meta":244,"style":244},"npx nuxt upgrade --force\n",[194,736,737],{"__ignoreMap":244},[248,738,739,741,743,745],{"class":250,"line":251},[248,740,255],{"class":254},[248,742,259],{"class":258},[248,744,695],{"class":258},[248,746,747],{"class":258}," --force\n",[650,749,750,765],{},[653,751,752,753,495,756,759,760,764],{},"If there is still an error related to ",[194,754,755],{},"sharp",[194,757,758],{},"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 ",[208,761,758],{"href":762,"rel":763},"https://github.com/nodejs/node-gyp#installation",[212]," for install requirements.",[653,766,767,768,773],{},"If none of the above worked, please ",[208,769,772],{"href":770,"rel":771},"https://github.com/nuxt/image/issues",[212],"open an issue"," and include error trace, OS, Node version and the package manager used for installing.",[775,776,777],"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":244,"searchDepth":382,"depth":382,"links":779},[780,781,782,783,787],{"id":228,"depth":382,"text":229},{"id":271,"depth":382,"text":272},{"id":420,"depth":382,"text":14},{"id":484,"depth":382,"text":485,"children":784},[785,786],{"id":523,"depth":394,"text":524},{"id":593,"depth":394,"text":594},{"id":644,"depth":382,"text":645},"Using image module in your Nuxt project is only one command away.","md",null,{},true,{"title":10,"description":788},"qZhQWYmRxwbEO-MR1z97_qOVw4ckXGJ_whBvOTGddu8",[790,796],{"title":14,"path":15,"stem":16,"description":797,"children":-1},"Nuxt Image is configured with sensible defaults.",1757511733840]