- Notifications
You must be signed in to change notification settings - Fork2
📐 Personal GitHub web page. Based on the minimal-mistakes Jekyll theme.
License
fjp/fjp.github.io
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
This repository holds the data for my blog. It is based on the thememinimal mistakes which is defined in the_config.yml
, an important configuration file for sites based onJekyll. Whenever I push commits to this GitHub repository it is automatically transformed byJekyll into a static site.You can see the result atfjp.github.io orfjp.at.
For this to work you need to enableGitHub pages in the repository settings.The default address of your GitHub page will be in the form ofusername.github.io
. If you already own a custom domain it is possible to use it with aCNAME
file and other requierd settings explained inManaging a custom domain for your GitHub Pages site.
Install gpg2 which is required forrvm
:
sudo apt install gpg2
Follow the instructions at to install rvm:
gpg2 --keyserver keyserver.ubuntu.com --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
\curl -sSL https://get.rvm.io | bash -s stable
Get the latest stable rvm version
rvm get stable
Install ruby usingrvm
:
rvm install ruby-3.2.2
To addrvm
to your path run the following commands:
echo "source $HOME/.rvm/scripts/rvm" >> ~/.bashrc. ~/.bashrc
Install Jekyll and Bundler gems trhough RubyGems:
gem install jekyll bundler
Install additional gems defined in the Gemfile:
bundle install
Serve the static web site:
bundle exec jekyll serve
The basic setup to get a similar site up and running is explained with the following steps.For more details checkouthttps://jekyllrb.com/docs/github-pages/
Install rubybrew install ruby
or on ubuntusudo apt-get install ruby
Install Jekyll and Bundler gems through RubyGemsgem install jekyll bundler
Create a new Jekyll site at ./myblogjekyll new myblog
Change into your new directorycd myblog
Build the site on the preview serverbundle exec jekyll serve
- Now browse tohttp://localhost:4000
- Add it to a new github repository named username.github.io
git initgit add .git add .gitignoregit commit -m "adds jekyll blog"git remote add origin https://github.com/username/username.github.io.gitgit push -u origin master
New posts are simply created in the `collections/_posts folder but the naming convention is important.For more details go tohttps://jekyllrb.com/docs/structure/
Add the changes to github by adding, committing and pushing the new post file.
Minimal Mistakes is a flexible two-column Jekyll theme, perfect for building personal sites, blogs, and portfolios. As the name implies, styling is purposely minimalistic to be enhanced and customized by you 😄.
✨ See what's new in theCHANGELOG.
If you enjoy this theme, please considersupporting me to continue developing and maintaining it.
Note: The theme uses thejekyll-include-cache plugin which will need to be installed in yourGemfile
and added to theplugins
array of_config.yml
. Otherwise you'll encounterUnknown tag 'include_cached'
errors at build.
- Bundled as a "theme gem" for easier installation/upgrading.
- Compatible with GitHub Pages.
- Support for Jekyll's built-in Sass/SCSS preprocessor.
- Nine different skins (color variations).
- Several responsive layout options (single, archive index, search, splash, and paginated home page).
- Optimized for search engines with support forTwitter Cards andOpen Graph data.
- Optionalheader images,custom sidebars,table of contents,galleries, related posts,breadcrumb links,navigation lists, and more.
- Commenting support (powered byDisqus,Facebook, Google+,Discourse, static-based viaStaticman, andutterances).
- Google Analytics support.
- UI localized text in English (default), Brazilian Portuguese (Português brasileiro), Catalan, Chinese, Danish, Dutch, Finnish, French (Français), German (Deutsch), Greek, Hindi (हिंदी), Hungarian, Indonesian, Irish (Gaeilge), Italian (Italiano), Japanese, Korean, Malayalam, Nepali (Nepalese), Persian (فارسی), Polish, Punjabi (ਪੰਜਾਬੀ), Romanian, Russian, Slovak, Spanish (Español), Swedish, Thai, Turkish (Türkçe), and Vietnamese.
This theme comes in nine different skins (in addition to the default one).
air | contrast | dark |
---|---|---|
dirt | mint | sunrise |
---|---|---|
aqua | neon | plum |
---|---|---|
Name | Description |
---|---|
Post with Header Image | A post with a large header image. |
HTML Tags and Formatting Post | A variety of common markup showing how the theme styles them. |
Syntax Highlighting Post | Post displaying highlighted code. |
Post with a Gallery | A post showing several images wrapped in<figure> elements. |
Sample Collection Page | Single page from a collection. |
Categories Archive | Posts grouped by category. |
Tags Archive | Posts grouped by tag. |
Additional sample posts are available underposts archive on the demo site. Source files for these (and the entire demo site) can be found in/docs
.
There are three ways to install: as agem-based theme, as aremote theme (GitHub Pages compatible), or forking/directly copying all of the theme files into your project.
With Gem-based themes, directories such as theassets
,_layouts
,_includes
, and_sass
are stored in the theme’s gem, hidden from your immediate view. Yet all of the necessary directories will be read and processed during Jekyll’s build process.
This allows for easier installation and updating as you don't have to manage any of the theme files. To install:
Add the following to your
Gemfile
:gem"minimal-mistakes-jekyll"
Fetch and update bundled gems by running the followingBundler command:
bundle
Set the
theme
in your project's Jekyll_config.yml
file:theme:minimal-mistakes-jekyll
To update the theme runbundle update
.
Remote themes are similar to Gem-based themes, but do not requireGemfile
changes or whitelisting making them ideal for sites hosted with GitHub Pages.
To install:
Create/replace the contents of your
Gemfile
with the following:source"https://rubygems.org"gem"github-pages",group::jekyll_plugins
Add
jekyll-include-cache
to theplugins
array of your_config.yml
.Fetch and update bundled gems by running the followingBundler command:
bundle
Add
remote_theme: "mmistakes/minimal-mistakes@4.19.1"
to your_config.yml
file. Remove any othertheme:
orremote_theme:
entry.
Looking for an example? Fork theMinimal Mistakes remote theme starter for the quickest method of getting a GitHub Pages hosted site up and running. Replace sample content with your own and configure as needed.
For detailed instructions on how to configure, customize, add/migrate content, and more read thetheme's documentation.
Having trouble working with the theme? Found a typo in the documentation? Interested in adding a feature orfixing a bug? Then by all meanssubmit an issue orpull request. If this is your first pull request, it may be helpful to read up on theGitHub Flow first.
Minimal Mistakes has been designed as a base for you to customize and fit your site's unique needs. Please keep this in mind when requesting features and/or submitting pull requests. If it's not something that most people will use, I probably won't consider it. When in doubt ask.
This goes for author sidebar links and "share button" additions -- I have no intention of merging in every possibly option, the essentials are there to get you started 😄.
When submitting a pull request:
- Clone the repo.
- Create a branch off of
master
and give it a meaningful name (e.g.my-awesome-new-feature
). - Open a pull request on GitHub and describe the feature or fix.
Theme documentation and demo pages can be found in the/docs
if submitting improvements, typo corrections, etc.
To set up your environment to develop this theme, runbundle install
.
To test the theme, runbundle exec rake preview
and open your browser athttp://localhost:4000/test/
. This starts a Jekyll server using content in thetest/
directory. As modifications are made to the theme and test site, it will regenerate and you should see the changes in the browser after a refresh.
Michael Rose
- The Noun Project -- Garrett Knoll, Arthur Shlain, andtracy tam
- Font Awesome
- Unsplash
- Jekyll
- jQuery
- Susy
- Breakpoint
- Magnific Popup
- FitVids.JS
- GreedyNav.js
- Smooth Scroll
- Gumshoe
- jQuery throttle / debounce
- Lunr
The MIT License (MIT)
Copyright (c) 2013-2020 Michael Rose and contributors
Permission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THESOFTWARE.
Minimal Mistakes incorporates icons fromThe Noun Projectcreators Garrett Knoll, Arthur Shlain, and tracy tam.Icons are distributed under Creative Commons Attribution 3.0 United States (CC BY 3.0 US).
Minimal Mistakes incorporatesFont Awesome,Copyright (c) 2017 Dave Gandy.Font Awesome is distributed under the terms of theSIL OFL 1.1andMIT License.
Minimal Mistakes incorporates photographs fromUnsplash.
Minimal Mistakes incorporatesSusy,Copyright (c) 2017, Miriam Eric Suzanne.Susy is distributed under the terms of theBSD 3-clause "New" or "Revised" License.
Minimal Mistakes incorporatesBreakpoint.Breakpoint is distributed under the terms of theMIT/GPL Licenses.
Minimal Mistakes incorporatesFitVids.js,Copyright (c) 2013 Dave Rubert and Chris Coyier.FitVids is distributed under the terms of theWTFPL License.
Minimal Mistakes incorporatesMagnific Popup,Copyright (c) 2014-2016 Dmitry Semenov,http://dimsemenov.com.Magnific Popup is distributed under the terms of the MIT License.
Minimal Mistakes incorporatesSmooth Scroll,Copyright (c) 2019 Chris Ferdinandi.Smooth Scroll is distributed under the terms of theMIT License.
Minimal Mistakes incorporatesGumshoejs,Copyright (c) 2019 Chris Ferdinandi.Smooth Scroll is distributed under the terms of theMIT License.
Minimal Mistakes incorporatesjQuery throttle / debounce,Copyright (c) 2010 "Cowboy" Ben Alman.jQuery throttle / debounce is distributed under the terms of theMIT License.
Minimal Mistakes incorporatesGreedyNav.js,Copyright (c) 2015 Luke Jackson.GreedyNav.js is distributed under the terms of theMIT License.
Minimal Mistakes incorporatesJekyll Group-By-Array,Copyright (c) 2015 Max Whitemushishi78@gmail.com.Jekyll Group-By-Array is distributed under the terms of theMIT License.
Minimal Mistakes incorporates@allejo's Pure Liquid Jekyll Table of Contents,Copyright (c) 2017 Vladimir Jimenez.Pure Liquid Jekyll Table of Contents is distributed under the terms of theMIT License.
Minimal Mistakes incorporatesLunr,Copyright (c) 2018 Oliver Nightingale.Lunr is distributed under the terms of theMIT License.
About
📐 Personal GitHub web page. Based on the minimal-mistakes Jekyll theme.