GithubHelp home page GithubHelp logo

mayang / bliss-template Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 448 KB

based on https://github.com/lwojcik/eleventy-template-bliss

License: MIT License

JavaScript 40.40% Nunjucks 26.58% SCSS 33.02%

bliss-template's Introduction

Bliss - Blog Theme For Eleventy

Bliss is a single-column blog template for Eleventy static site generator with strong focus on simplicity without sacrificing functionality.

It is a modified and improved version of the theme running Offbeat Bits - my personal blog.

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 <link rel="me"> 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
  • 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 demo

https://eleventy-bliss.lkmt.us/

Instant deploy

Netlify:

Deploy to Netlify

Vercel:

Deploy with Vercel

Render:

Deploy to Render

Configuration

See siteConfig.js. Inline documentation is available in the file.

Translation file

See 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:

  • Fill in all relevant information in siteConfig.js - site title, description, custom logo, author information, etc.
  • Modify production URL - either by hardcoding it in siteConfig.js or via process.env.URL environment variable
  • Replace site logo or remove the existing one to use site title as text in your header
  • Modify color palette to your liking - edit relevant variables in _variables.scss
  • If you changed the color palette - modify theme color and background color for PWA manifest - see siteConfig.js
  • If you changed the color palette - modify base color for RSS XSL stylesheet - see siteConfig.js
  • Enable automatic OpenGraph image generation - note that they only work for pages and posts
  • 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 or 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
  • Replace a favicon file (favicon.svg) with your own - only one file is needed, the remaining ones will be generated on build
  • 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! ๐Ÿ˜Š

Optional customizations

Make titles optional + use file slugs for permalinks

By default, the template assumes each post and each page to have a title and generates a permalink out using a slugify function. In other words, it converts A title like this! into a-title-like-this.

If you want your posts to have no title, open content/posts/posts.json file and modify the following line:

  "permalink": "{% if customPermalink %}{{ customPermalink }}{% else %}/{{ title | slugify }}/{% endif %}",

into the following:

  "permalink": "{% if customPermalink %}{{ customPermalink }}{% else %}/{{ page.fileSlug }}/{% endif %}",

You can do the same for pages by modifying content/pages/pages.json file.

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.

License

Licensed under the MIT license.

bliss-template's People

Contributors

mayang avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.