For new sites:
gem "jekyll-remote-theme"
to your Gemfile
to track the dependency._config.yml
.home.html
to index.html
and remove its title
attribute.bundle exec jekyll serve
to build and serve your site.For existing sites, the following parts of _config.yml should be copied:
remote_theme
(commented out in default, must be uncommented)navigation
titles_from_headings
paginate
, paginate_path
, and permalink
defaults
sectionAll of these settings should be customizable as you see fit, however the theme code expects/requires them to be present.
By default, this theme supports jekyll-readme-index
, so the homepage can be generated from an undecorated README.md
file (such as this). This does not provide the recommended blog reading experience.
If you wish to provide your own home page, you can start by copying home.html
to index.html
. This page relies on the home layout, which provides the three most-recent blog posts.
This theme creates several pages that are structured to group posts by tag, category, and author.
The site's front-end code automatically filters those pages when an associated anchor is used (e.g. #tagname
).
First, you should probably copy these pages out of the theme's source:
By default, all pages in the pages
directory get listed in the navigation menu.
This theme allows for pages to be excluded by adding a property to their frontmatter, menu: false
.
These pages will still be rendered, navigable by search engines, etc, but they will be excluded from the main navigation menu.
An example of disabling the listing of a specific page is provided at: pages/three.md
Other notes:
posts
by their origin in _posts
directory. Posts are not included in the menu.jekyll-readme-index
does not render index.html
correctly when the include
list in _config.yml
contains README.md
. Seemingly, this may be due to jekyll-optional-front-matter
converting it to README.html
too early.