Jekyll 主题 Kagami 安装与使用教程

Jekyll 主题 Kagami 安装与使用教程

jekyll-theme-kagami Simple and clean Jekyll theme compatible with GitHub Pages. 项目地址: https://gitcode.com/gh_mirrors/je/jekyll-theme-kagami

1. 项目目录结构及介绍

jekyll-theme-kagami/
├── _includes/
├── _layouts/
├── _sass/
├── assets/
├── example/
├── .gitignore
├── .gitmodules
├── .ruby-version
├── .travis.yml
├── Gemfile
├── LICENSE.txt
├── README.md
└── jekyll-theme-kagami.gemspec

目录结构说明

• _includes/: 包含用于页面布局的 HTML 片段。
• _layouts/: 包含页面的布局模板。
• _sass/: 包含 SASS 样式文件。
• assets/: 包含静态资源文件，如图片、CSS 和 JavaScript。
• example/: 包含示例网站的文件。
• .gitignore: Git 忽略文件列表。
• .gitmodules: Git 子模块配置文件。
• .ruby-version: Ruby 版本配置文件。
• .travis.yml: Travis CI 配置文件。
• Gemfile: Ruby 依赖管理文件。
• LICENSE.txt: 项目许可证文件。
• README.md: 项目说明文件。
• jekyll-theme-kagami.gemspec: Jekyll 主题的 gemspec 文件。

2. 项目启动文件介绍

Gemfile

source "https://rubygems.org"

gem "jekyll-theme-kagami"

_config.yml

theme: jekyll-theme-kagami

启动命令

bundle install
bundle exec jekyll serve -s example

说明

• Gemfile: 用于指定项目的 Ruby 依赖，包括 jekyll-theme-kagami。
• _config.yml: 项目的配置文件，指定使用的主题为 jekyll-theme-kagami。
• 启动命令: 安装依赖并启动 Jekyll 服务器，使用 example 目录作为网站根目录。

3. 项目的配置文件介绍

_config.yml

theme: jekyll-theme-kagami

# 社交账号链接
github_username: my_github_username
twitter_username: my_twitter_username
instagram_username: my_instagram_username

# 语法高亮
color_scheme: github

# 评论服务 (Disqus 或 Gitalk)
disqus_shortname: my_disqus_shortname

# Google Analytics
google_analytics: UA-NNNNNNNN-N

# 导航栏
navbar_title: Awesome Title
position: 999

# 标签和分类
title: Title of Tag Page
layout: post-list
filter:
  - by_tag: tagname
  - by_category: category

# MathJax
mathjax: true

# Mermaid
mermaid: true

配置说明

• theme: 指定使用的主题。
• 社交账号链接: 配置社交账号的用户名。
• 语法高亮: 选择语法高亮的颜色方案。
• 评论服务: 配置 Disqus 或 Gitalk 的参数。
• Google Analytics: 配置 Google Analytics 的跟踪 ID。
• 导航栏: 配置导航栏的标题和位置。
• 标签和分类: 配置标签和分类的过滤器。
• MathJax: 启用 MathJax 支持。
• Mermaid: 启用 Mermaid 图表支持。

通过以上配置，您可以自定义 Jekyll 主题 Kagami 的各种功能，以满足您的需求。

jekyll-theme-kagami Simple and clean Jekyll theme compatible with GitHub Pages. 项目地址: https://gitcode.com/gh_mirrors/je/jekyll-theme-kagami