bundle exec jekyll serveor
bundle exec jekyll serve --port 3000 --host 0.0.0.0on Gitpod
Overriding Includes and Layouts
Theme files can be overridden by placing a file with the same name into your project’s
_layouts directory. For instance:
To add another social sharing button to
_includes/social-share.html, create an
_includesdirectory in your project, copy
_includes/social-share.htmlfrom So Simple’s gem folder to
<your_project>/_includesand edit that file.
ProTip: to locate the theme’s files on your computer run
bundle show jekyll-theme-so-simple. This returns the location of the gem-based theme files.
So Simple is a simple Jekyll theme for your words and pictures. Built to provide:
- A variety of layouts with clean and readable typography.
- Microformats markup to make post content machine-readable and discoverable.
- Disqus Comments and Google Analytics support.
- SEO best practices via Jekyll SEO Tag.
- Options to customize the theme and make it your own.
If you enjoy this theme, please consider supporting me for developing and maintaining it.
✨ See what’s new in the CHANGELOG.
📘 v2 documentation.
A post with a large hero image.
A post with a variety of common HTML elements showing how the theme styles them.
Post displaying highlighted code.
A post displaying images with a variety of alignments.
All posts grouped by year.
All posts grouped by category.
All posts grouped by tag.
Listing of documents in grid view.
Additional sample posts can be view on the demo site. Source files for these (and the entire demo site) can be found in
Table of Contents
- Theme Text
- Global Changes
- Browser Support
- Configuration Changes
<li> <a rel="nofollow noopener" target="_blank" href="#search-changes">Search Changes</a> </li> <li> <a rel="nofollow noopener" target="_blank" href="#image-changes">Image Changes</a> </li> <li> <a rel="nofollow noopener" target="_blank" href="#development-changes">Development Changes</a> </li> <li> <a rel="nofollow noopener" target="_blank" href="#step-by-step">Step-by-Step</a> </li> </ol>
- Font Awesome Icons
If you’re running Jekyll v3.5+ and self-hosting you can quickly install the theme as a Ruby gem. If you’re hosting with GitHub Pages you can install as a remote theme or directly copy all of the theme files (see structure below) into your project.
Ruby Gem Method
Add this line to your Jekyll site’s
Gemfile(or create one):
Add this line to your Jekyll site’s
Then run Bundler to install the theme gem and dependencies:
GitHub Pages Method
GitHub Pages has added full support for any GitHub-hosted theme.
gem "github-pages", group: :jekyll_plugins
bundle updateand verify that all gems install properly.
remote_theme: "mmistakes/so-simple-theme"to your
_config.ymlfile. Remove any other
Note: Your Jekyll site should be viewable immediately at
http://USERNAME.github.io. If it’s not, you can force a rebuild by pushing empty commits to GitHub (see below for more details).
If you’re hosting several Jekyll based sites under the same GitHub username you will have to use Project Pages instead of User Pages. Essentially you rename the repo to something other than USERNAME.github.io and create a
gh-pages branch off of
master. For more details on how this works, check GitHub’s documentation.
Remove the Unnecessary
If you forked or downloaded the
so-simple-theme repo you can safely remove the following files and folders:
If you’re using the Ruby Gem or remote theme versions of So Simple, upgrading is fairly painless.
To check which version you are currently using, view the source of your built site and you should something similar to: