struggle
A simple, sleek and modern Jekyll blog theme made with love and Bootstrap.
fastpages
This theme is intended to be used with fastpages, but tries to improve the style significantly. Therefore apart from replacing the referenced theme minima, some further modifications are rquired.
Remove:
_includes/
_layouts/
_pages/
_sass/minima/
Start
See: https://code.visualstudio.com/docs/remote/create-dev-container
https://blog.webjeda.com/jekyll-categories/
Inspo
https://dribbble.com/fintory https://fintory.com/en/blog/why-is-motion-design-so-important-to-user-experience https://dribbble.com/shots/10540722-Investment-App-Wireframes
Resources
- Build Jekyll iamge
- Devcontainers
- https://www.chrisanthropic.com/blog/2016/creating-gem-based-themes-for-jekyll/
- https://www.codepedia.org/ama/how-to-handle-multiple-authors-in-jekyll/
- https://medium.com/better-programming/an-introduction-to-using-jekyll-with-bootstrap-4-6f2433afeda9
- https://gist.github.com/JJediny/a466eed62cee30ad45e2
https://pikock.github.io/bootstrap-magic/app/index.html#!/editor
Theme
- Best design
- Clean blog
- Blog example
- Central overlay example
- Color Scheme
- structure example
- clean white
- animated header
- clean color
- post example
- nice overview
- additional design rootui
- blog perfect layout
- central overlay
- theme
- logo
fixed float effect https://preview.envytheme.com/startp-react/
dark color scheme https://d-board-nextjs.mobifica.com/
Installation
Add this line to your Jekyll site's Gemfile
:
gem "struggle"
And add this line to your Jekyll site's _config.yml
:
theme: struggle
And then execute:
bundle
Or install it yourself as:
gem install struggle
Update
bundle outdated
bundle update
yarn outdated
yarn upgrade --latest
Contents At-A-Glance
Layouts
Refers to files within the _layouts
directory, that define the markup for your theme.
default.html
— The base layout that lays the foundation for subsequent layouts. The derived layouts inject their contents into this file at the line that says{{ content }}
and are linked to this file via FrontMatter declarationlayout: default
.home.html
— The layout for your landing-page / home-page / index-page. [More Info.]page.html
— The layout for your documents that contain FrontMatter, but are not posts.post.html
— The layout for your posts.
Home Layout
home.html
is a flexible HTML layout for the site's landing-page / home-page / index-page.
Main Heading and Content-injection
From Minima v2.2 onwards, the home layout will inject all content from your index.md
/ index.html
before the Posts
heading. This will allow you to include non-posts related content to be published on the landing page under a dedicated heading. We recommended that you title this section with a Heading2 (##
).
Usually the site.title
itself would suffice as the implicit 'main-title' for a landing-page. But, if your landing-page would like a heading to be explicitly displayed, then simply define a title
variable in the document's front matter and it will be rendered with an <h1>
tag.
Post Listing
This section is optional from Minima v2.2 onwards.
It will be automatically included only when your site contains one or more valid posts or drafts (if the site is configured to show_drafts
).
The title for this section is Posts
by default and rendered with an <h2>
tag. You can customize this heading by defining a list_title
variable in the document's front matter.
Includes
Refers to snippets of code within the _includes
directory that can be inserted in multiple layouts (and another include-file as well) within the same theme-gem.
disqus_comments.html
— Code to markup disqus comment box.footer.html
— Defines the site's footer section.google-analytics.html
— Inserts Google Analytics module (active only in production environment).head.html
— Code-block that defines the<head></head>
in default layout.custom-head.html
— Placeholder to allow users to add more metadata to<head />
.header.html
— Defines the site's main header section. By default, pages with a definedtitle
attribute will have links displayed here.social.html
— Renders social-media icons based on theminima:social_links
data in the config file.
Sass
Refers to .scss
files within the _sass
directory that define the theme's styles.
minima/skins/classic.scss
— The "classic" skin of the theme. Used by default.minima/initialize.scss
— A component that defines the theme's skin-agnostic variable defaults and sass partials. It imports the following components (in the following order):minima/custom-variables.scss
— A hook that allows overriding variable defaults and mixins. (Note: Cannot override styles)minima/_base.scss
— Sass partial for resets and defines base styles for various HTML elements.minima/_layout.scss
— Sass partial that defines the visual style for various layouts.minima/custom-styles.scss
— A hook that allows overriding styles defined above. (Note: Cannot override variables)
Refer the skins section for more details.
Assets
Refers to various asset files within the assets
directory.
assets/css/style.scss
— Imports sass files from within the_sass
directory and gets processed into the theme's stylesheet:assets/css/styles.css
.assets/minima-social-icons.svg
— A composite SVG file comprised of symbols related to various social-media icons. This file is used as-is without any processing. Refer section on social networks for its usage.
Plugins
Minima comes with jekyll-seo-tag
plugin preinstalled to make sure your website gets the most useful meta tags. See usage to know how to set it up.
Usage
Have the following line in your config file:
theme: minima
Customize navigation links
This allows you to set which pages you want to appear in the navigation area and configure order of the links.
For instance, to only link to the about
and the portfolio
page, add the following to your _config.yml
:
header_pages:
- about.md
- portfolio.md
Change default date format
You can change the default date format by specifying site.minima.date_format
in _config.yml
.
# Minima date format
# refer to http://shopify.github.io/liquid/filters/date/ if you want to customize this
minima:
date_format: "%b %-d, %Y"
Extending the <head />
You can add custom metadata to the <head />
of your layouts by creating a file _includes/custom-head.html
in your source directory. For example, to add favicons:
- Head over to https://realfavicongenerator.net/ to add your own favicons.
- Customize default
_includes/custom-head.html
in your source directory and insert the given code snippet.
Enabling comments (via Disqus)
Optionally, if you have a Disqus account, you can tell Jekyll to use it to show a comments section below each post.
To enable it, add the following lines to your Jekyll site:
disqus:
shortname: my_disqus_shortname
You can find out more about Disqus' shortnames here.
Comments are enabled by default and will only appear in production, i.e., JEKYLL_ENV=production
If you don't want to display comments for a particular post you can disable them by adding comments: false
to that post's YAML Front Matter.
:warning: url
, e.g. https://example.com
, must be set in you config file for Disqus to work.
Author Metadata
From Minima-3.0
onwards, site.author
is expected to be a mapping of attributes instead of a simple scalar value:
author:
name: John Smith
email: "[email protected]"
To migrate existing metadata, update your config file and any reference to the object in your layouts and includes as summarized below:
Minima 2.x | Minima 3.0 |
---|---|
site.author |
site.author.name |
site.email |
site.author.email |
Social networks
You can add links to the accounts you have on other sites, with respective icon, by adding one or more of the following options in your config.
From Minima-3.0
onwards, the usernames are to be nested under minima.social_links
, with the keys being simply the social-network's name:
minima:
social_links:
twitter: jekyllrb
github: jekyll
stackoverflow: "11111"
dribbble: jekyll
facebook: jekyll
flickr: jekyll
instagram: jekyll
linkedin: jekyll
pinterest: jekyll
telegram: jekyll
microdotblog: jekyll
keybase: jekyll
mastodon:
- username: jekyll
instance: example.com
- username: jekyll2
instance: example.com
gitlab:
- username: jekyll
instance: example.com
- username: jekyll2
instance: example.com
youtube: jekyll
youtube_channel: UC8CXR0-3I70i1tfPg1PAE1g
youtube_channel_name: CloudCannon
Enabling Google Analytics
To enable Google Analytics, add the following lines to your Jekyll site:
google_analytics: UA-NNNNNNNN-N
Google Analytics will only appear in production, i.e., JEKYLL_ENV=production
Enabling Excerpts on the Home Page
To display post-excerpts on the Home Page, simply add the following to your _config.yml
:
show_excerpts: true
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.
When your theme is released, only the files in _layouts
, _includes
, _sass
and assets
tracked with Git will be bundled.
To add a custom directory to your theme-gem, please edit the regexp in struggle.gemspec
accordingly.
License
The theme is available as open source under the terms of the MIT License.