diff --git a/README.md b/README.md index bf50d85..5bf1f3c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ **Bliss** is a single-column blog template for [Eleventy static site generator](https://11ty.dev) with strong focus on simplicity without sacrificing functionality. -It is a modified and improved version of the theme running [Offbeat Bits - my personal blog](https://offbeatbits.com/). +It is a modified and improved version of the theme running [my personal blog](https://blog.lukaszwojcik.net/). ## Features @@ -10,7 +10,6 @@ It is a modified and improved version of the theme running [Offbeat Bits - my pe - **sharing buttons for popular social media** (including Mastodon!) + copying post URL to clipboard - **Mastodon integration:** generating `.well-known/webfinger` file + automatic generation of `` tags for site ownership verification - **translation ready** (support for custom language tags + separate file with static phrases) -- **automatic favicon generation** - **manifest file** for PWA - **automatic OpenGraph image generation** - **code syntax highlighting** with PrismJS using [Eleventy syntax highlighting plugin](https://www.11ty.dev/docs/plugins/syntaxhighlight/) @@ -36,8 +35,6 @@ npm run dev # to launch the project for modifications npm run build # to build production version ``` -**If you use Windows / Powershell 7:** If you get an error `Error: EBUSY: resource busy or locked` while starting the project, check [this issue](https://github.com/lwojcik/eleventy-template-bliss/issues/91) for possible workarounds. - ## Instant deploy Netlify: @@ -75,7 +72,8 @@ Non-exhaustive list of steps to make the template **your own**. Some of them are - [ ] If you use post disclaimers at the beginning of your posts - consider using the built-in disclaimer feature - see [`06-10-sample-post-33-disclaimer.md`](./content/posts/2023/06-10-sample-post-33-disclaimer.md) or [`05-31-sample-post-32-linked-disclaimer.md`](./content/posts/2023/05-31-sample-post-32-linked-disclaimer.md) for reference - [ ] Add your own pages - use one of the existing placeholder pages as a reference - [ ] Add / remove meta pages in the footer - see [`siteConfig.js`](./content/_data/siteConfig.js) -- [ ] Replace a favicon file (`favicon.svg`) with your own - only one file is needed, the remaining ones will be generated on build +- [ ] Replace a favicon files (`favicon.svg`, `favicon.ico`, `apple-touch-icon.png`, `icon-192.png`, `icon-512.png`) with your own +- [ ] Update `manifest.webmanifest` file with data relevant to your site - [ ] Replace OpenGraph images with ones relevant to your site - [ ] Decide if you want to use automated OpenGragh image generation + consider modifying their appearance to suit your taste (see `siteConfig.js` for more info) - [ ] Copy your existing static assets to `assets` folder. Note that the top of `assets` folder corresponds to the _root directory_ of your site (`_site`) @@ -102,6 +100,12 @@ into the following: You can do the same for pages by modifying `content/pages/pages.json` file. +### Automatic favicon generation + +Until version 2.4.0 Bliss was bundled with a [favicon generation plugin](https://www.npmjs.com/package/eleventy-plugin-gen-favicons). Due to unresolved bugs this plugin is no longer included with the template. + +If you want to reimplement it yourself, change history from [this pull request](https://github.com/lwojcik/eleventy-template-bliss/pull/99) may be helpful. + ## Contributions Contributions of the following kind are welcome: diff --git a/_11ty/plugins.js b/_11ty/plugins.js index 17c99a9..73ea4f2 100644 --- a/_11ty/plugins.js +++ b/_11ty/plugins.js @@ -7,7 +7,6 @@ const eleventyNavigationPlugin = require('@11ty/eleventy-navigation'); const srcSet = require('./plugins/srcset'); const pluginPWA = require('eleventy-plugin-pwa-v2'); const syntaxHighlight = require('@11ty/eleventy-plugin-syntaxhighlight'); -const faviconsPlugin = require('eleventy-plugin-gen-favicons'); const productionPlugins = IS_PRODUCTION ? [ @@ -59,23 +58,6 @@ const plugins = [ { body: syntaxHighlight, }, - { - body: faviconsPlugin, - options: { - manifestData: { - name: siteConfig.site.title, - lang: siteConfig.site.language, - short_name: siteConfig.site.title, - description: siteConfig.site.description, - start_url: '/', - scope: '/', - display: 'standalone', - theme_color: siteConfig.manifestJson.themeColor, - background_color: siteConfig.manifestJson.backgroundColor, - orientation: 'any', - }, - }, - }, ]; module.exports = [...plugins, ...pwaPluginConfig, ...productionPlugins]; diff --git a/assets/apple-touch-icon.png b/assets/apple-touch-icon.png new file mode 100644 index 0000000..7a11353 Binary files /dev/null and b/assets/apple-touch-icon.png differ diff --git a/assets/favicon.ico b/assets/favicon.ico new file mode 100644 index 0000000..c5ec8fd Binary files /dev/null and b/assets/favicon.ico differ diff --git a/assets/icon-192.png b/assets/icon-192.png new file mode 100644 index 0000000..a5f09ad Binary files /dev/null and b/assets/icon-192.png differ diff --git a/assets/icon-512.png b/assets/icon-512.png new file mode 100644 index 0000000..8e434e0 Binary files /dev/null and b/assets/icon-512.png differ diff --git a/assets/manifest.webmanifest b/assets/manifest.webmanifest new file mode 100644 index 0000000..75909be --- /dev/null +++ b/assets/manifest.webmanifest @@ -0,0 +1,24 @@ +{ + "name": "Bliss", + "lang": "en", + "short_name": "Bliss", + "description": "Simple Eleventy blog template", + "start_url": "/", + "scope": "/", + "display": "standalone", + "theme_color": "#1773cf", + "background_color": "#1773cf", + "orientation": "any", + "icons": [ + { + "src": "/icon-192.png", + "type": "image/png", + "sizes": "192x192" + }, + { + "src": "/icon-512.png", + "type": "image/png", + "sizes": "512x512" + } + ] +} \ No newline at end of file diff --git a/content/_includes/partials/head/favicons.njk b/content/_includes/partials/head/favicons.njk index 21f2238..5a78a26 100644 --- a/content/_includes/partials/head/favicons.njk +++ b/content/_includes/partials/head/favicons.njk @@ -1 +1,4 @@ -{%- favicons 'assets/favicon.svg', appleIconPadding=0 -%} \ No newline at end of file + + + + \ No newline at end of file diff --git a/package.json b/package.json index 0371b70..d717cb1 100644 --- a/package.json +++ b/package.json @@ -34,7 +34,6 @@ "cross-env": "^7.0.3", "crypto-js": "^4.2.0", "eleventy-plugin-emoji": "^1.1.0", - "eleventy-plugin-gen-favicons": "^1.1.2", "eleventy-plugin-pwa-v2": "^1.0.1", "eslint": "^8.56.0", "eslint-plugin-import": "^2.29.1",