Overview:

Kagami is a simple and clean theme for Jekyll and GitHub Pages. It offers a range of features and customization options to create a visually appealing website.

Features:

• Social account links: Customize social account links in the website’s configuration file.
• Syntax highlighting: Supports color schemes from jekyll-pygments-themes for syntax highlighting in code snippets.
• Comment service (Disqus or Gitalk): Enable comment service for the website using either Disqus or Gitalk.
• Google Analytics: Add Google Analytics tracking to the website for monitoring traffic and user behavior.
• Navigation Bar: Register pages and posts as navigation items with customizable ordering.
• Tags and category filtering: Filter and display posts based on tags and categories.
• MathJax: Enable MathJax for mathematical equations and formulas in posts.
• Mermaid: Enable mermaid diagrams for visual representation of complex information.
• .side-note and .retina2x: Use additional elements to enhance writing, such as sidenotes and retina2x images.

Installation:

To install the Kagami theme in your Jekyll site, follow these steps:

1. Add the following line to your Jekyll site’s Gemfile:

gem 'jekyll-theme-kagami'

2. Add the following line to your Jekyll site’s _config.yml file:

theme: jekyll-theme-kagami

3. Execute the following command in your Jekyll site’s root folder:

bundle install

Alternatively, you can install the theme manually by downloading the latest gem file from https://rubygems.org/gems/jekyll-theme-kagami and running the following command in your Jekyll site project folder:

gem unpack [path-to-downloaded-gem-file] --target=.

Make sure to delete the line theme: ... in your _config.yml file if you choose this method.

Please note that when using GitHub Pages, the Jekyll build is integrated with limited function. To use the theme with GitHub Pages hosted sites, refer to the provided instructions on the official GitHub repository.

Summary:

Kagami is a simple and clean theme for Jekyll and GitHub Pages that offers a range of features for customization. It provides options for social account links, syntax highlighting, comment services, Google Analytics integration, navigation bar customization, filtering by tags and categories, MathJax support, mermaid diagrams, and additional elements for enhanced writing. The installation process involves adding the theme to the Jekyll site’s Gemfile and configuring it in the _config.yml file.