Skip to content

Repository files navigation

Chirpy Starter

Gem Version  GitHub license

When installing the Chirpy theme through RubyGems.org, Jekyll can only read files in the folders _data, _layouts, _includes, _sass and assets, as well as a small part of options of the _config.yml file from the theme's gem. If you have ever installed this theme gem, you can use the command bundle info --path jekyll-theme-chirpy to locate these files.

The Jekyll team claims that this is to leave the ball in the user’s court, but this also results in users not being able to enjoy the out-of-the-box experience when using feature-rich themes.

To fully use all the features of Chirpy, you need to copy the other critical files from the theme's gem to your Jekyll site. The following is a list of targets:

.
├── _config.yml
├── _plugins
├── _tabs
└── index.html

To save you time, and also in case you lose some files while copying, we extract those files/configurations of the latest version of the Chirpy theme and the CD workflow to here, so that you can start writing in minutes.

Usage

Check out the theme's docs.

Local Development

This site uses jekyll-theme-chirpy ~> 7.2, which requires Ruby 3.1 or newer. The GitHub Pages workflow in this repository builds with Ruby 3.3.

On macOS, a straightforward setup is:

brew install ruby@3.3
export PATH="/opt/homebrew/opt/ruby@3.3/bin:$PATH"
bash serve.sh

If bundle is still unavailable after switching Ruby, run:

gem install bundler

Skill 安装与使用(AI Auto Note)

仓库内置了一个用于自动沉淀学习笔记的 skill:skills/ai-auto-note-publisher

如果你希望在 Codex 中全局复用,可安装到 $CODEX_HOME/skills

mkdir -p "$CODEX_HOME/skills"
cp -R skills/ai-auto-note-publisher "$CODEX_HOME/skills/"

如果你希望在 Claude Code 中复用,可安装到 ~/.claude/skills

mkdir -p ~/.claude/skills
cp -R skills/ai-auto-note-publisher ~/.claude/skills/

安装后,在需要时触发该 skill,并通过以下命令生成笔记:

python3 skills/ai-auto-note-publisher/scripts/create_ai_auto_note.py \
  --title "你的学习主题" \
  --input tmp/notes.txt \
  --repo-root .

可选:如果你要覆盖自动分类,可传 --subcategory(例如 ragagentspaper-readingproductivitygeneral)。

论文场景中,脚本支持从 arXiv:2501.12345 这类文本自动规范化为 https://arxiv.org/abs/2501.12345

生成并提交后,如需自动推送 PR 到本仓库(需要已安装并登录 gh):

cat > tmp/pr-body.md <<'EOF'
## Summary
- add ai auto notes
EOF

bash skills/ai-auto-note-publisher/scripts/push_note_pr.sh \
  --branch feat/ai-auto-note-2026-03-12 \
  --title "feat: add ai auto notes" \
  --body-file tmp/pr-body.md

Contributing

This repository is automatically updated with new releases from the theme repository. If you encounter any issues or want to contribute to its improvement, please visit the theme repository to provide feedback.

License

This work is published under MIT License.

Releases

Packages

Used by

Contributors

Languages