Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eduard-sukharev/eduard-sukharev.github.io

GitHub pages blog
https://github.com/eduard-sukharev/eduard-sukharev.github.io

eleventy static-site

Last synced: about 1 month ago
JSON representation

GitHub pages blog

Awesome Lists containing this project

README 

        
# Bliss - Blog Theme For Eleventy



**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/).



## Features



- **light / dark mode switcher** + honoring browser color scheme preference

- **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/)

- **HTML, JS, JSON, CSS** optimizations

- **RSS, JSON, Twtxt.txt** feeds + JSON-LD data

- **accessibility** features

- **HSL color palette** and CSS variables for straightforward personalization

- modular CSS augmented with SASS

- custom disclaimers alongside post content

- and more



## Live demos



On Netlify: https://eleventy-bliss.netlify.app/



On Vercel: https://eleventy-bliss.vercel.app/



## Instant deploy



Netlify:



[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/lwojcik/eleventy-template-bliss)



Vercel:



[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/lwojcik/eleventy-template-bliss)



## Configuration



See [`siteConfig.js`](./content/_data/siteConfig.js). Inline documentation is available in the file.



## Translation file



See [`phrases.js`](./content/_data/phrases.js) for the list of translatable static phrases.



## Personalization checklist



Non-exhaustive list of steps to make the template **your own**. Some of them are optional, others are highly recommended:



- [x] Fill in all relevant information in [`siteConfig.js`](./content/_data/siteConfig.js) - site title, description, custom logo, author information, etc.

- [x] Modify production URL - either by hardcoding it in [`siteConfig.js`](./content/_data/siteConfig.js) or via `process.env.URL` environment variable

- [x] Replace site logo or remove the existing one to use site title as text in your header

- [X] Modify color palette to your liking - edit relevant variables in [`_variables.scss`](./src/styles/_variables.scss)

- [x] If you changed the color palette - modify theme color and background color for PWA manifest - see [`siteConfig.js`](./content/_data/siteConfig.js)

- [x] If you changed the color palette - modify base color for RSS XSL stylesheet - see [`siteConfig.js`](./content/_data/siteConfig.js)

- [ ] Enable automatic OpenGraph image generation - note that they only work for pages and posts

- [x] Add your own posts - use the existing placeholder posts as a reference

- [ ] 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

- [x] Add / remove meta pages in the footer - see [`siteConfig.js`](./content/_data/siteConfig.js)

- [x] Replace a favicon file (`favicon.svg`) with your own - only one file is needed, the remaining ones will be generated on build

- [x] 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`)

- [ ] Modify anything else you don't like about the theme to match your preferences

- [ ] Enjoy! :)



## Contributions



Contributions of the following kind are welcome:



- bug reports / fixes

- documentation improvements

- improvements of existing features



I consider the project complete and apart from specific exceptions, no new features are planned.



Before contributing be sure to read [Code of Conduct](./CODE_OF_CONDUCT.md).



## License



Licensed under the [MIT license](./LICENSE).