Jekyll Template

This Jekyll template configured to use with GitHub Pages.

It supports:

• Home page with short list of posts, projects, category clowd, tag clowd, header with navigation menu, and footer.
• Posts with one category and tags.
• Section "Posts" with full list of posts.
• Section "Projects" with full list of projects.
• Tag system with support of related tags if necessary, and with page for each tag with full list of posts, and subsection "See Also by Tags".
• About page.

Copying contents of this repository. No need to clone or fork it! Unless of course you are going to improve this template and make a pull request.

Previously

In GNU/Linux with rbenv

• Install rbenv from sources:

  git clone https://github.com/rbenv/rbenv.git ~/.rbenv
  ~/.rbenv/bin/rbenv init

• Install ruby-build:

  git clone https://github.com/rbenv/ruby-build.git "$(rbenv root)"/plugins/ruby-build

• Build and install latest Ruby:

  rbenv install --list
  rbenv install 3.4.5
  rbenv global 3.4.5

Note You will probably need to install the build tools and libraries. Be guided by the messages issued during the building process.

In Ubuntu Linux with APT

• Install Ruby https://www.ruby-lang.org:

  sudo apt install ruby ruby-dev

• Setting up Ruby: add to .profile:

  if [ -d "$HOME/.local/share/gem/ruby/3.0.0" ] ; then
    RUBY_PATH="$HOME/.local/share/gem/ruby/3.0.0"
    export RUBY_PATH
    GEM_HOME="$RUBY_PATH"
    export GEM_HOME
    PATH="$RUBY_PATH/bin:$PATH"
  fi
  

• Install Ruby gems bundler and jekyll:

  gem install bundler jekyll --user-install

In Ubuntu Linux with SNAP

• Install Ruby https://www.ruby-lang.org:

  sudo snap install ruby --classic

• Install Make for building native bundles:

  sudo apt install make g++

In Fedora Linux with DNF

sudo dnf install ruby ruby-devel

Configuring

Edit this files:

• _config.yml: edit your personal data.
• _posts: add your posts.
• _categories: add your categories.
• _tags: add your tags.
• _projects: add your projects.
• about.html: write something about you.
• Gemfile: add Jekyll plugins if you need.

To change limits for showing posts and projects in list in Home page edit in index.html constants post-list-limit and project-list-limit in frontmatter.

Building

bundle install
bundle exec jekyll build

Preview

bundle exec jekyll serve --incremental --livereload

Updating

bundle outdated
bundle update github-pages

Posts adding

• Open folder _posts and add a new file into her by sample.
• Then don't forget to remove these examples.
• For posts use post layout.

Tags adding

• Open folder tags and add a new file into her in slug name format by sample.
• Then don't forget to remove these examples.
• For tag page use tag layout.
• In order for the tag to appear in the tag cloud, it must be used in some post.

Categories adding

• Open the folder categories and add a new file into her in slug name format by sample.
• Then don't forget to remove these examples.
• For category page use category layout.
• In order for the category to appear in the category cloud, it must be used in some post.

Projects adding

• Open the folder _projects and add a new file into her by sample.
• Then don't forget to remove these examples.
• For project page use project layout.
• Categories and tags are not applicable for projects. (Is it necessary?)

Jekyll Compose

You can also use Jekyll Compose.

What's next?

Read the Jekyll documentation and check with GitHub Pages documentation.

License

(CC)(0)

(c) Evgeny Simonenko, 2020-2024