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