Jekyll Scholar 开源项目使用指南

Jekyll Scholar 开源项目使用指南

jekyll-scholarjekyll extensions for the blogging scholar项目地址:https://gitcode.com/gh_mirrors/je/jekyll-scholar

1. 项目的目录结构及介绍

Jekyll Scholar 是一个专为学术出版物设计的 Jekyll 插件，它简化了在静态网站上展示研究论文、引用和其他学术内容的过程。下面是其基本的目录结构概述及其重要组件介绍：

.
├── _includes              # 包含自定义的 HTML 片段，如用于引用或作者信息的模板。
├── _plugins               # 存放插件代码，包括 Jekyll-Scholar 的核心功能。
│   └── jekyll-scholar.rb  
├── _sass                  # SCSS 样式表，用于定制化样式。
├── assets                 # 静态资源，如图片、CSS 和 JavaScript 文件。
├── _config.yml            # 主配置文件，包含了 Jekyll 以及 Jekyll-Scholar 的设置。
├── _bibliography         # BibTeX 文件存储处，用来存放你的文献引用数据。
├── _drafts                # 草稿文件夹，未发布的文章或页面存放位置。
├── _posts                 # 文章存放地，支持 Markdown 或其他 Jekyll 支持的格式。
├── _pages                 # 非博客文章类页面，如关于页、作品集等。
└── index.html             # 主页或入口文件。

2. 项目的启动文件介绍

_config.yml

在 Jekyll Scholar 的上下文中，启动或关键配置主要通过 _config.yml 文件进行。这个文件不仅控制着 Jekyll 基础的站点设置，还特别包含了一系列与 Jekyll Scholar 相关的配置项，例如 BibTeX 数据库的位置、引用的格式化方式、是否启用自动索引生成等。示例配置片段可能包含：

scholar:
  bibliography: _bibliography/research.bib      # 引用数据库文件路径
  citations: author-year                        # 引用风格
  display: publications                         # 在哪里显示公开的出版物

其他启动考虑

虽然没有特定的“启动文件”，但在首次使用时，确保正确安装了 Jekyll 和 Jekyll-Scholar gem，并在项目的 Gemfile 中添加相应的依赖是必要的步骤，之后通过 bundle install 确保所有依赖都已就位。

3. 项目的配置文件介绍

_config.yml 中的 Jekyll Scholar 配置

Jekyll Scholar 的配置主要位于 _config.yml 文件中，以下是一些关键配置项的说明：

• bibliography: 指定 BibTeX 文件的位置，该文件存储了所有的参考文献。
• citations: 设定引用的显示格式，如 author-year 或 numeric.
• display: 控制出版物在站点上的显示方式，可以选择只在特定页面显示或全局显示。
• details: 可以选择是否显示每条引用的详细信息。
• sorting: 设置默认的排序方式，比如按年份或作者排序。
• replace_strings: 提供了一个转换字符串的机会，比如将常见的缩写替换为其全称。

此外，为了更精细的控制，还可以配置每一条具体的 publication metadata，在文章或页面的前端 matter 中指定引用的 BibTeX key来插入引用，从而实现个性化引用和出版物展示。

注意：根据实际项目需求调整 _config.yml 中的选项是使 Jekyll Scholar 符合个人或项目需求的关键步骤。务必阅读官方文档获取最新的配置选项和详细说明。

jekyll-scholarjekyll extensions for the blogging scholar项目地址:https://gitcode.com/gh_mirrors/je/jekyll-scholar