A simple red Jekyll theme with left navigation that's perfect for portfolios and resumes.
See the sample r-jekyll-theme implementation.
You can install the github-remote or gem-based r-jekyll-theme. You can also fork the r-jekyll-theme GitHub repository.
You need to create a directory for your Jekyll site and initialize a Gemfile
.
Ensure that you have Ruby and Jekyll installed. See Jekyll - Quickstart.
- Create a directory in which you want to develop your Jekyll site.
- In the site directory, run
bundle init
Result: AGemfile
is created.
If you plan to deploy your Jekyll site to GitHub-Pages, use this installation method.
-
To the
Gemfile
, add:gem "github-pages" gem "jekyll-remote-theme"
-
In the site directory, create the
_config.yml
file. -
To the
_config.yml
file, add:plugins: - jekyll-remote-theme remote_theme: rafalkaron/r-jekyll-theme@main
-
Run
bundle
If you're into old school, use this installation method.
-
To the
Gemfile
, add:gem "github-pages" gem "r-jekyll-theme"
-
In the site directory, create the
_config.yml
file. -
To the
_config.yml
file, add:theme: r-jekyll-theme
-
Run
bundle
If you want to heavily modify the template, use this installation method.
- Fork the r-jekyll-theme repository.
- In the root directory of the forked repository, run
bundle
The r-jekyll-theme requires little configuration. You just need to add some content and fill in the _config.yml
file with your site data and contact information.
You add content by creating Markdown files in the root directory of your Jekyll site.
NOTE: You should start adding your content by creating the index.md
file.
-
In the root directory of your Jekyll site, create a Markdown file.
For example, create theindex.md
file. -
Open the file and add:
--- layout: page title: Home order: "0" ---
where:
layout
is the site HTML template. Always use thepage
value.title
is the page title that appears in the site navigation and in the web browser tab.order
is the position of the page link in the site navigation.
-
Add Markdown (Kramdown) content.
For reference, see content.md.
TIP: To keep your files organized, add any media files to theassets
directory. -
Save the Markdown file.
You configure site metadata and contact information by editing the _confing.yml
file. For reference, see the default _config.yml.
You can override the default styling by creating the main.scss
file in the assets
directory.
-
In the root directory of your Jekyll site, create the
assets
directory. -
In the
assets
directory, create and open themain.scss
file. -
To the
main.scss
file, add:--- --- @import "r";
-
Under the
@import "r";
rule, add your styling. -
Save the
main.scss
file.
You can generate and preview your site locally before publishing it.
-
Set up your development environment by running
bundle install
-
Run
bundle exec jekyll serve
-
In your web browser, go to
http://localhost:4000
-
Add pages, documents, data, styling etc. For more information, see Jekyll Home.
Info: As you modify the theme or add content, your site should regenerate automatically in the web browser. However, to see any_config.yml
updates, you need to restart the server.
If your site does not regenerate automatically in the web browser, ensure that you have the following added to your_config.yml
file:livereload: true