Are you happy with your logging solution? Would you help us out by taking a 30-second survey? Click here

minima

Minima is a one-size-fits-all Jekyll theme for writers.

Subscribe to updates I use minima


Statistics on minima

Number of watchers on Github 770
Number of open issues 33
Average time to close an issue 14 days
Main language CSS
Average time to merge a PR 15 days
Open pull requests 41+
Closed pull requests 17+
Last commit over 1 year ago
Repo Created over 3 years ago
Repo Last Updated over 1 year ago
Size 337 KB
Homepage https://jekyll.gi...
Organization / Authorjekyll
Latest Release2.4.0
Contributors8
Page Updated
Do you use minima? Leave a review!
View open issues (33)
View minima activity
View on github
Fresh, new opensource launches 🚀🚀🚀
Trendy new open source projects in your inbox! View examples

Subscribe to our mailing list

Evaluating minima for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)

minima

Minima is a one-size-fits-all Jekyll theme for writers. It's Jekyll's default (and first) theme. It's what you get when you run jekyll new.

Theme preview

minima theme preview

Installation

Add this line to your Jekyll site's Gemfile:

gem "minima"

And add this line to your Jekyll site:

theme: minima

And then execute:

$ bundle

Contents At-A-Glance

Minima has been scaffolded by the jekyll new-theme command and therefore has all the necessary files and directories to have a new Jekyll site up and running with zero-configuration.

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 declaration layout: 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.

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.
  • header.html — Defines the site's main header section. By default, pages with a defined title attribute will have links displayed here.

Sass

Refers to .scss files within the _sass directory that define the theme's styles.

  • minima.scss — The core file imported by preprocessed main.scss, it defines the variable defaults for the theme and also further imports sass partials to supplement itself.
  • minima/_base.scss — Resets and defines base styles for various HTML elements.
  • minima/_layout.scss — Defines the visual style for various layouts.
  • minima/_syntax-highlighting.scss — Defines the styles for syntax-highlighting.

Assets

Refers to various asset files within the assets directory. Contains the main.scss that imports sass files from within the _sass directory. This main.scss is what gets processed into the theme's main stylesheet main.css called by _layouts/default.html via _includes/head.html.

This directory can include sub-directories to manage assets of similar type, and will be copied over as is, to the final transformed site directory.

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

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.

--

Customization

To override the default structure and style of minima, simply create the concerned directory at the root of your site, copy the file you wish to customize to that directory, and then edit the file. e.g., to override the _includes/head.html file to specify a custom style path, create an _includes directory, copy _includes/head.html from minima gem folder to <yoursite>/_includes and start editing that file.

The site's default CSS has now moved to a new place within the gem itself, assets/main.scss. To override the default CSS, the file has to exist at your site source. Do either of the following:

  • Create a new instance of main.scss at site source.
    • Create a new file main.scss at <your-site>/assets/
    • Add the frontmatter dashes, and
    • Add @import "minima";, to <your-site>/assets/main.scss
    • Add your custom CSS.
  • Download the file from this repo
    • Create a new file main.scss at <your-site>/assets/
    • Copy the contents at assets/main.scss onto the main.scss you just created, and edit away!
  • Copy directly from Minima 2.0 gem
    • Go to your local minima gem installation directory ( run bundle show minima to get the path to it ).
    • Copy the assets/ folder from there into the root of <your-site>
    • Change whatever values you want, inside <your-site>/assets/main.scss

--

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 you _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"

--

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.

--

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:

twitter_username: jekyllrb
github_username:  jekyll
dribbble_username: jekyll
facebook_username: jekyll
flickr_username: jekyll
instagram_username: jekyll
linkedin_username: jekyll
pinterest_username: jekyll
youtube_username: jekyll
googleplus_username: +jekyll
rss: rss

mastodon:
 - username: jekyll
   instance: example.com
 - username: jekyll2
   instance: example.com

--

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

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jekyll/minima. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Development

To set up your environment to develop this theme, run script/bootstrap.

To test your theme, run script/server (or bundle exec jekyll serve) and open your browser at http://localhost:4000. This starts a Jekyll server using your theme and the contents. As you make modifications, your site will regenerate and you should see the changes in the browser after a refresh.

License

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

minima open issues Ask a question     (View All Issues)
  • about 3 years Hamburger menu doesn't work on iOS
  • about 3 years role=banner attribute on <header>
  • about 3 years h1 font-size not specified
  • about 3 years Configuring time format
  • about 3 years Hyperlink in "description" _config.yml?
  • about 3 years Demo
  • about 3 years Inline SVG v SVG files
  • about 3 years Improve loading time
  • about 3 years Social Media Icons / Links
  • over 3 years Restore ability to style YAML
  • over 3 years Ability to specify Pages in Header
  • over 3 years Theme hardcodes CSS path to `css/main.css`
minima open pull requests (View All Pulls)
  • Use upstream gemspec file matcher
  • Use absolute_url filter for disqus
  • Remove incomplete status from spec summary
  • Close #55: Improve mobile user experience
  • Basic i18n implementation
  • replace `example/index.html` with `example/index.md`
  • add `header_pages` config to link only specific files in header
  • [Experimental] Use SVG Sprite
  • Corrected misspelled word
  • Remove duplicate .sass-cache
  • Use date_format if set in configuration
  • Add disqus on example config
  • Update README with theme content description
  • Add support for excerpts on homepage
  • handling content outside of posts
  • Provide a hook for theme users to inject custom CSS
  • fix hamburger menu for iOs
  • Remove 2.0 post-install message
  • modify Rakefile to watch assets folder as well
  • Update 'Customization' section in README
  • Scale headings relative to base-font-size
  • Demo minima on GitHub Pages
  • refactor scss to mobile-first
  • Change RSS references
  • Provide exclude mechanism for minima
  • added support for txtpen
  • Bigger font-size for h1 in posts
  • Generalize and reorganize social media links #39
  • Include jekyll-seo-tag when present
  • Replace `twitter_username` with `twitter:username`
  • Doc: Give some informations concerning Disqus account on README, base…
  • fix: styling main element in IE 11
  • Adding Mastodon to the social networks
  • fix(css): prevent title from getting covered
  • Improve the wording in index.md
  • init development v3.0
  • Consolidate trigger SVG paths
  • Convert social-links column into a row of icons
  • HTML escape author in posts
  • Make `social` configuration section as more legibly
  • WIP: Fix HTML Validator Errors
minima questions on Stackoverflow (View All Questions)
  • Find (local) minima of function over intervall
  • Finding local maxima and minima
  • Find all local Maxima and Minima when x and y values are given as numpy arrays
  • why Backpropagation algorithm in neural nets stuck in local minima?
  • Gnuplot-Set colorbar Maxima and Minima
  • Finding local minima from set of points in octave/python
  • what is the best solution about local minima in deep neural networks?
  • Finding local maxima/minima with Numpy in a 1D numpy array
  • Determining minima, subscript out of range error
  • What are minima and maxima point sets of a signature in digital image processing
  • local every minima in a kernel density function with R
  • Not able to get minima of function using symbolic math toolbox
  • ow to refer to the location of minima in a different matrix in matlab?
  • Finding minima and replacing values in pandas Dataframe
  • Find local minima in an array
  • Find local minima/maxima
  • find minima and replace with character string in r
  • Finding local maxima and minima in R
  • How can I use the Second Derivative test to find Maxima and Minima in MATLAB
  • Remove minima from inner dimension in NumPy 2D array
  • 3-Layer Neural Network Getting Stuck in Local Minima
  • MLP classifier in theano settles at local minima
  • Count total extrema in the array in java(Total minima and maxima)
  • Find most dominant local minima
  • Iterating over elements, finding minima per each element
  • Finding local minima and local maxima
  • Fastest way to calculate a point between minima and maxima
  • Generic minima filter
  • Local minima on 2D array with custom filter
  • Finding local maxima/minima with Numpy in a 3D numpy array + Watershed Tranformation
minima list of languages used
minima latest release notes
2.4.0 2.4.0

Minor Enhancements

  • Add better system fonts (#205)
  • Remove whitespace due to Liquid tags in generated HTML (#202)
  • Adding Mastodon to the social networks (#198)

Bug Fixes

  • social icons should resolve baseurl properly (#201)
  • fix: styling main element in IE 11 (#199)

Documentation

  • Improve thw wording in index.md (#175)
  • Update config description comment (#203)
v2.3.0 v2.3.0
  • Add option to show excerpts on the homepage (#90)
  • Handle RSS feed with jekyll-feed (#183)
  • Test build with Ruby 2.4 on CI (#184)
  • Document how to customize navigation links (#192)
v2.2.1 v2.2.1
  • Revert social_sites hash for retrocompatibility (#190)
Other projects in CSS