Skip to content

Commit a0adb3a

Browse files
committed
readme: document that this plugin doesn't affect Jekyll Assets
1 parent 2c4a670 commit a0adb3a

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@
44
[![CI](https://github.com/tkareine/jekyll-minibundle/workflows/CI/badge.svg)][MinibundleCI]
55

66
A straightforward asset bundling plugin for [Jekyll], utilizing external
7-
minification tool of your choice. It provides asset concatenation for
8-
bundling and asset fingerprinting with MD5 digest for cache busting.
7+
asset conversion/minification tool of your choice. The plugin provides
8+
asset concatenation for bundling and asset fingerprinting with [MD5]
9+
digest for cache busting.
910

1011
There are no runtime dependencies, except for the minification tool used
1112
for bundling (fingerprinting has no dependencies).
@@ -17,6 +18,10 @@ The plugin works with Jekyll's watch mode (auto-regeneration, Jekyll
1718
option `--watch`), but not with incremental feature enabled (Jekyll
1819
option `--incremental`).
1920

21+
Minibundle plugin does not affect the behavior of Jekyll's [built-in
22+
asset conversion][JekyllBuiltInAssets]. The plugin is designed to
23+
incorporate the results produced by external asset tools only.
24+
2025
## Features
2126

2227
There are two features: fingerprinting with [MD5 digest][MD5] over the
@@ -506,6 +511,7 @@ MIT. See [LICENSE.txt].
506511

507512
[Gemfile]: https://bundler.io/gemfile.html
508513
[GoogleWebDevHttpCache]: https://web.dev/http-cache/
514+
[JekyllBuiltInAssets]: https://jekyllrb.com/docs/assets/
509515
[JekyllConf]: https://jekyllrb.com/docs/configuration/
510516
[JekyllLiquidFilters]: https://jekyllrb.com/docs/liquid/filters/
511517
[JekyllMinibundleExampleSite]: https://github.com/tkareine/jekyll-minibundle-example

0 commit comments

Comments
 (0)