Skip to content

jitinnair1/snippet-book

Repository files navigation

snippet-book

Composite example of the Catppuccin theme for snippet-book

snippet-book is a Jekyll blog theme based on jekyll-theme-console with a few changes:

  • Catpucchin theme defaults for light and dark mode
  • User's preferred style (light/dark) is used by default

Previews

🌻 Latte Preview of Latte theme
🪴 Frappé Preview of Frappé theme
🌺 Macchiato Preview of Macchiato theme
🌿 Mocha Preview of Mocha theme

Usage

_config.yaml

In addition to jekyll's default configuration options, you can provide:

  • style_light and style_dark to specify which predefined style (colors) should be used for light and dar modes
style_light: "latte" # available options: latte, frappe, macchiato, mocha
style_dark: "macchiato" # available options: latte, frappe, macchiato, mocha

front matter variables

Besides the predefined front matter variables from jekyll this theme also supports following variables:

  • title to set a title for the page
  • lang to specify the language, defaults to 'en'
  • robots to control the robot meta tag (details) - this may be useful for example to set NOINDEX to tag pages

Customization

If you want to customize this theme, follow this steps:

  1. Fork this repository (you can use the fork as your own theme or directly as your website)
  2. Create or modify files in _layouts directory for html-based changes
  3. Create or modify files in _sass under assets for css-based changes
    • You can change things which are used in light and dark theme (like font-size) in _sass/base.scss. You'll find style variables at the top.
    • Catppuccin colours are under assets/_sass/colours/_<name-of-theme>.scss. These varaibles are then used to specify theme-specific colours in _sass/theme/_theme-<name-of-theme>.scss.

Development

To set up your environment to develop this theme, run bundle install.

Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

License

The theme is available as open source under the terms of the MIT License.

PS: If you liked the theme, do star ⭐ it! Thanks!

Also, check out:

  • autoCV - a LaTeX template that builds and deploys the CV using GitHub Actions, so you will always have a ready link for your latest CV
  • gradfolio - a minimal, quick-setup template for a personal website/portfolio
  • Tail - a minimal, quick-setup template for a blog

About

terminal style, clean Jekyll blog theme with catppuccin colours

Topics

Resources

License

Stars

Watchers

Forks