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