Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tbela99 committed Feb 7, 2021
1 parent ac3d844 commit b0e54ed
Show file tree
Hide file tree
Showing 14 changed files with 972 additions and 910 deletions.
11 changes: 9 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,15 @@

## 2.9.0

- Preserve background transparency #117
- New [CSS parser](https://github.com/tbela99/css) #67
- New [CSS parser](https://github.com/tbela99/css) and minifier #67
- Resize background images in inline css #116
- Preserve background transparency when resizing #117
- \[bug\] Fix an issue with responsive images #95
- \[bug\] PWA start_url missing from preloaded urls #113
- \[bug\] Cannot download sourcemap file #112
- \[bug\] fix an error in the service worker #104
- Convert CSS inline images to webp #93
- Parse and minify inline CSS attribute #105

## 2.8.1

Expand Down
47 changes: 23 additions & 24 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,29 @@

1. implement backgroundFetch API
2. make the custom pwa prompt optional and configurable. the user may choose to use the browser defaults.
3. font-display css property is set only when parse critical css is enabled. it should be set independantly
4. merge javascript and css files using groups in order to leverage cache. for example we can merge common libraries in one bundle and other files which depend on the current page in another bundle
5. implement new manifest file [properties](https://developer.mozilla.org/en-US/docs/Web/Manifest)
6. customize image quality settings (jpeg image quality, jpeg optimization method)
7. improved LQIP for [jpeg files](https://www.smashingmagazine.com/2019/08/faster-image-loading-embedded-previews/)
8. better detect character encoding when manually editing the offline page HTML
9. modify service worker cache and network fallback and cache only to attempt an update after a specified time (it will behave like cache and network update with a delayed update)
10. [bug] When fetch remote scripts is off and a local copy is hosted locally, the local copy should not be used
11. [feature] Validate integrity data when the integrity attribute is provided for link and script before minifying / merging them together
12. Implement manual dns prefetch?
13. add support for the user action Log see [here](https://docs.joomla.org/J1.x:User_Action_Logs)
14. do not cache partial request?
15. intercept partial requests and return response from cache?
16. merge multiple google font < link > tag?
17. Fetch remote resources periodically (configurable) (css, javascript, fonts, ...). This can be usefull for analytic scripts and and hosted fonts.
18. Web push notifications with firebase?
19. prerender images using primitive.js svg generation [https://github.com/ondras/primitive.js/blob/master/js/app.js](https://github.com/ondras/primitive.js/blob/master/js/app.js)
20. Messaging API (broadcasting messages to and from all/single clients)
21. Remove < Link rel=preload > http header and use < link > HTML tag instead. see [here](https://jakearchibald.com/2017/h2-push-tougher-than-i-thought/)
22. CSS: deduplicate, merge properties, rewrite rules, etc
23. Disk quota management see [here](https://developer.chrome.com/apps/offline_storage) and [here](https://developer.mozilla.org/fr/docs/Web/API/API_IndexedDB/Browser_storage_limits_and_eviction_criteria) and [here](https://gist.github.com/ebidel/188a513b1cd5e77d4d1453a4b6d060b0)
24. Clear Site Data api see [here](https://www.w1.org/TR/clear-site-data/)
25. code refactoring: make helper properties protected or private and use wrapper methods instead
26. Implement expiring urls?
3. merge javascript and css files using groups in order to leverage cache. for example we can merge common libraries in one bundle and other files which depend on the current page in another bundle
4. implement new manifest file [properties](https://developer.mozilla.org/en-US/docs/Web/Manifest)
5. customize image quality settings (jpeg image quality, jpeg optimization method)
6. improved LQIP for [jpeg files](https://www.smashingmagazine.com/2019/08/faster-image-loading-embedded-previews/)
7. better detect character encoding when manually editing the offline page HTML
8. modify service worker cache and network fallback and cache only to attempt an update after a specified time (it will behave like cache and network update with a delayed update)
9. [bug] When fetch remote scripts is off and a local copy is hosted locally, the local copy should not be used
10. [feature] Validate integrity data when the integrity attribute is provided for link and script before minifying / merging them together
11. Implement manual dns prefetch?
12. add support for the user action Log see [here](https://docs.joomla.org/J1.x:User_Action_Logs)
13. do not cache partial request?
14. intercept partial requests and return response from cache?
15. merge multiple google font < link > tag?
16. Fetch remote resources periodically (configurable) (css, javascript, fonts, ...). This can be usefull for analytic scripts and and hosted fonts.
17. Web push notifications with firebase?
18. prerender images using primitive.js svg generation [https://github.com/ondras/primitive.js/blob/master/js/app.js](https://github.com/ondras/primitive.js/blob/master/js/app.js)
19. Messaging API (broadcasting messages to and from all/single clients)
20. Remove < Link rel=preload > http header and use < link > HTML tag instead. see [here](https://jakearchibald.com/2017/h2-push-tougher-than-i-thought/)
21. CSS: deduplicate, merge properties, rewrite rules, etc
22. Disk quota management see [here](https://developer.chrome.com/apps/offline_storage) and [here](https://developer.mozilla.org/fr/docs/Web/API/API_IndexedDB/Browser_storage_limits_and_eviction_criteria) and [here](https://gist.github.com/ebidel/188a513b1cd5e77d4d1453a4b6d060b0)
23. Clear Site Data api see [here](https://www.w1.org/TR/clear-site-data/)
24. code refactoring: make helper properties protected or private and use wrapper methods instead
25. Implement expiring urls?

## Low priority list

Expand Down
2 changes: 1 addition & 1 deletion bgstyles.es6
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,6 @@ LIB.ready(function (undef) {
}

window.addEventListener('resize', updateBgStyle, false);
setTimeout(updateBgStyle, 10);
setTimeout(updateBgStyle, 25);
}
});
2 changes: 1 addition & 1 deletion bgstyles.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,6 @@ LIB.ready((function(e) {
}));
})), o.sort((function(e, t) {
return t - e;
})), window.addEventListener("resize", n, !1), setTimeout(n, 10);
})), window.addEventListener("resize", n, !1), setTimeout(n, 25);
}
}));
2 changes: 1 addition & 1 deletion bgstyles.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

73 changes: 59 additions & 14 deletions docs/css.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,77 @@ Configure CSS settings.

Enable or disable CSS processing

### Font Display

Set font-display css property. It requires Parse Critical CSS settings must be enabled

### Fetch Remotely Hosted CSS

Fetch CSS files hosted on remote servers.

### Ignored CSS files
## CSS Optimization Settings

If you want to exclude a css file from processing add a pattern that match that file here.
### Load CSS Async

### Removed CSS Files
Asynchronously load css so that page rendering is not blocked while css files are loading. CSS files will be moved at the bottom of the page. We should configure critical css in order to avoid FOUC

Remove a css file from the page. Any file that matches the pattern provided is removed from the page
### Minify CSS

## CSS Optimization Settings
Enable or disable merging css files together

### Minify CSS
### Merge CSS

Enable or disable merging css files together

### Load CSS Async
### Parse Inline CSS Attribute

Asynchronously load css so that page rendering is not blocked while css files are loading. CSS files will be moved at the bottom of the page. We should configure critical css in order to avoid FOUC
Parse CSS defined in HTML 'style' attribute

### Merge CSS
## CSS Parser Options

### Parse Import Rule

Enable or disable @import processing

### Allow Duplicate Rules

Enable or disable duplicate rules. This does not apply to @font-face

### Allow Duplicate Declarations

Enable or disable duplicate declarations in the same rule

## CSS Rendering Options

### CSS Level

The CSS Level specification used to render colors

### Convert Colors

Convert CSS colors to the format selected. The value NONE means no color conversion will be made

### Remove Comments

Enable or disable CSS comments removal

### Remove Empty Rules

Enable or disable empty rules removal

## Web Fonts Settings

### Preload Web Fonts

Enable or disable web fonts preloading

### Font Display

Set font-display css property.

## Misc

### Ignored CSS files

Ignore css files that match the specified pattern

### Removed CSS Files

Remove css files that match the specified pattern

Enable or disable merging css files together
4 changes: 4 additions & 0 deletions docs/images.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ Firefox will send this header
Accept: image/webp,*/*
```

### Convert Inline Background

Convert background images defined in HTML 'style' attribute

### Crop Method

Algorithm used when resizing images. Values are:
Expand Down
Loading

0 comments on commit b0e54ed

Please sign in to comment.