Click Use this template button above for the quickest method of getting started with the Minimal Mistakes Jekyll theme.
Contains basic configuration to get you a site with:
- Sample posts.
- Sample top navigation.
- Sample author sidebar with social links.
- Sample footer links.
- Paginated home page.
- Archive pages for posts grouped by year, category, and tag.
- Sample about page.
- Sample 404 page.
- Site wide search.
Replace sample content with your own and configure as necessary.
If you have a question about using Jekyll, start a discussion on the Jekyll Forum or StackOverflow. Other resources:
- Ruby 101
- Setting up a Jekyll site with GitHub Pages
- Configuring GitHub Metadata to work properly when developing locally and avoid
No GitHub API authentication could be found. Some fields may be missing or have incorrect data.
warnings.
Some info that'll be useful later:
Steps:
-
Install Ruby:
-
Follow steps given here Installation | Jekyll • Simple, blog-aware, static sites
-
Check if Ruby is installed by typing ruby -v
-
-
Install jekyll:
-
In a new command window, type
gem install jekyll bundler
-
Initializing:
-
Create a folder for website, say 'website1'. Navigate to that folder
-
To create a gemfile, type
bundle init
. Within the newly greated gemfile, addgem "jekyll"
-
Run the following:
-
bundle
-
bundle add webrick
-
-
Create an html file, say
index.html
and save it in the 'website1' folder. -
Build the site:
-
jekyll build
-
jekyll serve
(orjekyll serve --livereload
). Go tolocalhost:4000
to see what the website will look like.
-
In order to use a specific theme, one may use the remote theme option (in which one tells the server to use the theme files stored in a GitHub repository maintaned by developers), or install a theme. I found the latter to be more suitable, since I wanted to make my own changes to the theme I was planning to use. (It is possible to make changes even in the remote theme option, but there is a risk of something breaking if the remote repository becomes incompatible with the changes you make.)
Here are the steps I followed:
-
Create my website repository (
pratiksathe.github.io
) -
Copy all the files from the
Minimal Mistakes
repository into this repository. Clone the repository on my computer. -
Open cmd into the repo folder, and do
bundle
,bundle add webrick
,bundle update
andbundle install
. -
Do
bundle exec jekyll serve --livereload
. Go tolocalhost:4000
in a browser. Making any changes in the folder will be reflected immediately in the browser. -
Make the changes you want, such as editing or adding posts and pages. If you want to make changes to the theme, make appropriate edits to the sass, layout files etc.
-
If it all looks good at
localhost:4000
commit and push changes.
After doing all this, the website will be available at username.github.io
.
In order to host the website on GitHub after buying a domain from Google domains, follow the instructions here link.