Skip to content

docs: document where to put static images - #341

Merged
pi0 merged 5 commits into
nuxt:mainfrom
flozero:doc/update-ipx-documentation
Jun 29, 2021
Merged

docs: document where to put static images#341
pi0 merged 5 commits into
nuxt:mainfrom
flozero:doc/update-ipx-documentation

Conversation

@flozero

@flozero flozero commented Jun 26, 2021

Copy link
Copy Markdown
Contributor

I think default behavior is missing for IPX.

Adding this will add more clarity. But for the alternative serverMiddleware the default behavior is a bit mistyc. Is it recommended to put it inside static folder ?

Because if you do that you have use /static/myimg when the default behavior for other is not set the static

Don't know what you think about it.

@codecov-commenter

codecov-commenter commented Jun 26, 2021

Copy link
Copy Markdown

Codecov Report

Merging #341 (bde960c) into main (d9aeae2) will decrease coverage by 0.06%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #341      +/-   ##
==========================================
- Coverage   59.36%   59.30%   -0.07%     
==========================================
  Files          26       26              
  Lines         598      602       +4     
  Branches      149      188      +39     
==========================================
+ Hits          355      357       +2     
- Misses        243      245       +2     
Impacted Files Coverage Δ
src/module.ts 92.85% <0.00%> (-3.30%) ⬇️
src/runtime/image.ts 66.37% <0.00%> (-1.52%) ⬇️
src/runtime/providers/vercel.ts 0.00% <0.00%> (ø)
src/provider.ts 74.28% <0.00%> (+2.06%) ⬆️
src/runtime/providers/ipx.ts 100.00% <0.00%> (+15.38%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d9aeae2...bde960c. Read the comment docs.

@pi0 pi0 changed the title update documentation on default behavior docs: document where to put static images Jun 29, 2021
@pi0

pi0 commented Jun 29, 2021

Copy link
Copy Markdown
Member

Thanks @f3ltron for this PR. It totally makes sense. I think we can merge it with previous work (#318) and move both to default provider sectiction

(because <nuxt-image> is documenting component not provider and ipx is documenting ipx provider in general not default configuration)

@pi0
pi0 requested review from atinux and danielroe June 29, 2021 16:48
@flozero

flozero commented Jun 29, 2021

Copy link
Copy Markdown
Contributor Author

Thanks @f3ltron for this PR. It totally makes sense. I think we can merge it with previous work (#318) and move both to default provider sectiction

(because <nuxt-image> is documenting component not provider and ipx is documenting ipx provider in general not default configuration)

I agree but ipx is not checking at static folder by default right? Is it an issue from this provider ?


For more information, you can learn more about the [static directory here](https://nuxtjs.org/docs/2.x/directory-structure/static).
:::alert{type="info"}
With [default provider](/getting-started/providers#default-provider), you should put `/nuxt-icon.png` inside `static/` directrory for making above example working.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo on directory

@atinux

atinux commented Jun 29, 2021

Copy link
Copy Markdown
Member

Except the typo I believe it is a good improvements to the documentation.

We cannot get it perfect at first but through iterations 💚

@flozero

flozero commented Jun 29, 2021

Copy link
Copy Markdown
Contributor Author

Definitely but we are working hard on it :p to make it better. It's already really good

@pi0

pi0 commented Jun 29, 2021

Copy link
Copy Markdown
Member

(updated the clartification for serverMiddleware that needs explicitly setting images dir)

@pi0
pi0 merged commit 22d5de2 into nuxt:main Jun 29, 2021
@flozero
flozero deleted the doc/update-ipx-documentation branch June 29, 2021 23:17
procrates pushed a commit to procrates/nuxt-image that referenced this pull request Feb 21, 2023
Co-authored-by: Pooya Parsa <pyapar@gmail.com>
@github-actions github-actions Bot mentioned this pull request Jul 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants