[SQIP] Add documentation #5287
[SQIP] Add documentation #5287
Conversation
| @@ -48,6 +48,8 @@ const data = { | |||
| }, | |||
| } | |||
|
|
|||
| // @todo move all the styles to css file | |||
| to get a feeling of how the pictures will look like, even{' '} | ||
| <strong>before</strong> they got loaded by their (probably) slow | ||
| connection. | ||
| </p> |
There was a problem hiding this comment.
non-jsx example missing here.
Add copyright hint for background image, too
| @@ -2,25 +2,144 @@ | |||
|
|
|||
| Generates vectorized primitive version of images to be used as preview thumbnails. | |||
|
|
|||
|
|
|||
| @todo add some example gif | |||
There was a problem hiding this comment.
@todo add example gif
|
|
||
| Some research: https://axe312ger.github.io/embedded-svg-loading-impact-research/ | ||
|
|
||
| @todo image with loading time impact from webpagetest.com |
There was a problem hiding this comment.
@todo this whole section is still very incomplete
|
Deploy preview for gatsbygram ready! Built with commit b89e446 |
|
Deploy preview for using-drupal ready! Built with commit b89e446 |
|
This looks like it's coming together nicely, it's great to see detailed docs like this :) Drop a note here whenever this is ready for review. |
axe312ger
force-pushed
the
docs/using-sqip
branch
from
6e37a19
to
4cc0356
Compare
axe312ger
changed the title
|
Especially @m-allanson but for everybody: This is ready for review. The only missing piece is the example gif for the readme, will follow soon ™️ |
|
Deploy preview for using-glamor failed. Built with commit 52cfd5c https://app.netlify.com/sites/using-glamor/deploys/5b0ff73011b73b2d6d8fa4f8 |
Same as my local issue as mentioned on discord 🙈 |
|
Looking 👍! Is there an invisible character in the Using section? I'm seeing a question mark:
Otherwise I think this is ready to go in once the gif is added. |
| } | ||
| ``` | ||
|
|
||
| With ` gatsby-transformer-contentful`: |
There was a problem hiding this comment.
This should be with gatsby-source-contentful ? :)
|
I guess this is ready for merge or at least some re-reviews :) |
axe312ger
force-pushed
the
docs/using-sqip
branch
from
502d113
to
b89e446
Compare
|
If ✅ is given, this should be squash-merged into one commit :) |
* master: (26 commits) Publish [feat] Extract internal plugin for automatically creating pages so we can reuse for other directories (#4490) fix(contentful): properly delete deleted entries and assets (#5756) Fix typo add Linda's post (#5817) [gatsby-source-contentful] Fix prepareJSONNode for array normalization (#5107) Process Contentful images inlined in markdown (#5542) feat(contentful): add traced SVGs to Contentful images (#5659) [SQIP] Add documentation (#5287) Add site to showcase (#5819) [gatsby-remark-copy-linked-files] Support reference-style images (#5818) Update docs for gatsby-plugin-catch-links (#5843) Added ⋅ representing a space to sub-list examples to reflect actual code (#5829) Adding tigerfacilityservices.com to showcase (#5855) fix schema type conflict reporter regressions (#5805) [gatsby-plugin-feed] Support nested output directory (#5820) Make cache available to the plugins (#5840) [gatsby-source-contentful] update data and jest snapshots (#5802) [gatsby-plugin-manifest] Replace all manifest.json with manifest.webmanifest in comments/docs (#5157) Update deploy-gatsby.md (#5800) ... # Conflicts: # docs/tutorial/part-one/index.md # examples/using-sqip/src/components/polaroid.js # packages/gatsby-image/README.md # packages/gatsby-image/package.json # packages/gatsby-plugin-catch-links/package.json # packages/gatsby-plugin-feed/package.json # packages/gatsby-plugin-manifest/package.json # packages/gatsby-plugin-page-creator/src/gatsby-node.js # packages/gatsby-remark-copy-linked-files/package.json # packages/gatsby-source-contentful/package.json # packages/gatsby-source-contentful/src/__tests__/__snapshots__/normalize.js.snap # packages/gatsby-source-contentful/src/extend-node-type.js # packages/gatsby-source-contentful/src/gatsby-node.js # packages/gatsby-source-contentful/src/normalize.js # packages/gatsby-transformer-remark/package.json # packages/gatsby-transformer-remark/src/__tests__/__snapshots__/gatsby-node.js.snap # packages/gatsby-transformer-sqip/package.json # packages/gatsby-transformer-sqip/src/extend-node-type.js # packages/gatsby/package.json # packages/gatsby/src/bootstrap/load-plugins/__tests__/__snapshots__/load-plugins.js.snap # packages/gatsby/src/bootstrap/load-plugins/load.js # www/src/data/sites.yml
My working PR for the upcoming SQIP documentation. This is not ready yet, I just prefer pull requests to track my own progress.
Comments are still welcome, ofc :)
Readme preview: https://github.com/axe312ger/gatsby/tree/docs/using-sqip/packages/gatsby-transformer-sqip
Example preview: https://deploy-preview-5287--using-sqip.netlify.com/