Jekyll Crosspost to Medium 开源项目指南

Jekyll Crosspost to Medium 开源项目指南

jekyll-crosspost-to-mediumA Jekyll generator for automatically crossposting to Medium项目地址:https://gitcode.com/gh_mirrors/je/jekyll-crosspost-to-medium

---

项目概述

Jekyll Crosspost to Medium 是一个专为 Jekyll 博客系统设计的插件，它允许用户轻松地将他们在 Jekyll 网站上发布的文章自动跨发布到 Medium 平台，从而扩大内容的影响力。该插件由 Aaron Gustafson 开发并维护，简化了多平台内容发布的流程。

---

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

项目的基本目录结构简洁而目的明确，核心组件集中在确保无缝集成到Jekyll的工作流中。以下是关键的目录和文件说明：

.
├── _config.yml          # 主配置文件，包括插件设置
├── _drafts              # 草稿文件夹，存放未发布的文章
├── _includes            # 包含各种可以在文章或布局中重复使用的部分
├── _layouts             # 文章和页面的布局模板
├── _plugins             # 自定义的Jekyll插件，包括crosspost至Medium的脚本
│   └── jekyll-crosspost.rb # 核心插件文件
├── _posts               # 正式发布的文章存储位置
├── _site                # Jekyll构建后的静态网站输出目录
└── README.md            # 项目说明文档

• _config.yml 中可以启用并配置此插件。
• _plugins/jekyll-crosspost.rb 是实现跨发功能的核心代码。

---

2. 项目的启动文件介绍

主要关注点是_config.yml 和 _plugins/jekyll-crosspost.rb 文件。

_config.yml

在您的Jekyll配置文件中，您需要添加特定于此插件的配置项来激活跨posting功能。示例配置可能包括Medium的API凭据和其他定制选项，以控制哪些文章被发布以及如何发布。

crosspost_to_medium:
  consumer_key: "YOUR_CONSUMER_KEY"
  consumer_secret: "YOUR_CONSUMER_SECRET"
  token: "YOUR_ACCESS_TOKEN"
  token_secret: "YOUR_TOKEN_SECRET"
  tags: ["jekyll", "medium"]
  only_published: true

_plugins/jekyll-crosspost.rb

这个Ruby脚本是插件的主要逻辑所在，处理与Medium API的交互，识别要跨发的文章，并执行实际的跨平台发布操作。用户通常不需要直接编辑此文件，除非想要对插件的行为进行深度定制。

---

3. 项目的配置文件介绍

主要配置文件即为_config.yml。它不仅管理着Jekyll的基础设置，如站点元数据、Markdown解析器等，还专门有一节用于配置crosspost_to_medium。通过上述示例配置，您可以指定Medium应用的认证信息，决定是否只跨发已发布的文章，可以自定义文章标签，并控制其他行为细节。

此外，尽管不是直接的“配置文件”，但_plugins/jekyll-crosspost.rb内的默认设置也是可调整的，提供了进一步定制的可能性。理解其内部逻辑可以帮助高级用户进行更精细的调整，以适应个性化需求。

通过这样的配置和理解，开发者可以轻易地集成该插件，实现在保持本地博客的同时，无缝同步内容到Medium，拓展阅读群体。

jekyll-crosspost-to-mediumA Jekyll generator for automatically crossposting to Medium项目地址:https://gitcode.com/gh_mirrors/je/jekyll-crosspost-to-medium