From caa7a63fa6f731c093ba3cab48734023810a86f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Sat, 22 Aug 2020 17:56:40 +0200 Subject: Update README.md --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 34e1f05..862cb68 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,22 @@ # Hugo JS Libraries -A small collection of JS libraries that works well with Hugo, packaged and ready for use as Hugo Modules. +A small collection of JS libraries that works well with Hugo, packaged and ready for use as Hugo Modules. + +Hugo has great support for [JavaScript building](https://gohugo.io/hugo-pipes/js/), but these libraries stand solid on their own and you don't need `npm` to use them. It's similar to including the libraries from CDN, but you get the added benefit of: + +* Offline use. +* They are aware of the Hugo life cycle (minify, fingerprint, add integrity hash only when in production). +* The dependencies can be vendored (`hugo mod vendor`) to make your site truly standalone. +* ... + +To use AlpineJS with Turbolinks you can just import the modules into your config and then add this to youer `head` + +``` +{{ partialCached "jslibs/alpinejs/script-src.html" "-" }} +{{ partialCached "jslibs/turbolinks/script-src.html" "-" }} +``` See each component's README for usage. The Hugo documentation has more information about [Hugo Modules](https://gohugo.io/hugo-modules/). + +## Versioning + -- cgit v1.2.3