Skip to content

Commit aeaf0eb

Browse files
kastnerpclaude
andcommitted
Merge al-folio v1.1 (pre-v1 monolith -> gem plugin architecture)
The fork was last synced against a pre-v1.0 al-folio, where layouts, includes and styles lived in this repo. al-folio v1.x moves all of that into the al_folio_core / al_* gem family, so this merge deletes the local copies and keeps only files we intentionally customise as overrides. Overrides kept (gem-owned paths): _includes/figure.liquid skip webp srcset for GIFs; pass `style` through _includes/footer.liquid Umami analytics (al_analytics has no Umami provider) _includes/header.liquid navbar wordmark via site.logo.* _includes/repository/repo.liquid pin show_owner=false across our three orgs _layouts/about.liquid hide title/subtitle, capitalised section headings _layouts/bib.liquid publications/ preview dir, DOI button suppressed _layouts/page.liquid team profile portraits + GitHub README embed assets/css/main.scss adds `@use "custom"` Overrides dropped, now covered upstream or by config: _includes/repository/repo_user.liquid stats host is now external_services.* _includes/social.liquid replaced by a jekyll-socials custom entry (linkedin_company) in _data/socials.yml _sass/_base.scss pre-v1 monolith; the two site rules moved to _sass/_themes.scss _sass/_custom.scss (theme-aware-logo was dead CSS, and v1 handles the tri-state theme toggle natively) Also: _pages/code.md passes repository=repo.id so the gem include works with our object-form _data/repositories.yml; upstream demo content this fork had already removed stays removed; feedjira/httparty dropped (unused - the profile-readme plugin uses stdlib open-uri). Picks up the v1.1 security fixes: Swiper 12.1.2 (CVE-2026-27212, CVSS 9.4), polyfill.io removed from MathJax, and Distill's remote loader disabled (allow_remote_loader: false). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2 parents 5d05dfe + e4342b9 commit aeaf0eb

290 files changed

Lines changed: 8490 additions & 73860 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# al-folio Bootstrap
2+
3+
Use this skill when a user asks an agent to create, configure, or personalize a new al-folio v1.x website.
4+
5+
## Workflow
6+
7+
1. Read `AGENTS.md` and `docs/BOUNDARIES.md` before editing.
8+
2. Keep the starter small: customize `_config.yml`, `_data`, content collections, and site assets first.
9+
3. Leave runtime behavior in plugin repos. Do not copy plugin-owned layouts, includes, Sass, JavaScript, or assets into the starter unless the user intentionally wants a local override.
10+
4. For local visual/content customization, prefer:
11+
- `_config.yml` feature flags and site metadata
12+
- `_data/*.yml`
13+
- `_pages`, `_posts`, `_projects`, `_news`, `_teachings`, `_bibliography`
14+
- local `_includes`, `_layouts`, and `_sass` overrides only when config/content cannot express the change
15+
5. Run validation before handing work back:
16+
17+
```bash
18+
npm ci
19+
npm run lint:prettier
20+
bundle exec al-folio upgrade audit --no-fail
21+
bundle exec jekyll build --baseurl /al-folio
22+
```
23+
24+
## Routing
25+
26+
- Starter wiring/docs/examples/tests: edit `al-folio`.
27+
- Shared layouts/includes/assets: use `al_folio_core`.
28+
- CV rendering: use `al_folio_cv`.
29+
- Distill runtime: use `al_folio_distill`.
30+
- Search/icons/math/comments/analytics/citations/external posts/newsletter/charts/images: use the owning `al-*` plugin repo.
31+
32+
## Handoff
33+
34+
Summarize changed files, validation results, and any local overrides created.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# al-folio v1 Migration
2+
3+
Use this skill when a user asks an agent to migrate an existing customized al-folio fork to v1.x.
4+
5+
## Workflow
6+
7+
1. Work in a disposable branch, fork, or clone. Do not overwrite the user's original site.
8+
2. Start from the v1 starter contract, then bring over site-owned files:
9+
- `_config.yml` values
10+
- `_data`
11+
- `_bibliography`
12+
- content collections
13+
- site assets
14+
- intentional local `_includes`, `_layouts`, and `_sass` overrides
15+
3. Keep v1 plugin wiring from the starter:
16+
- `theme: al_folio_core`
17+
- bundled `al_*` and `al_folio_*` gems in `Gemfile`
18+
- bundled plugin entries in `_config.yml`
19+
4. Remove stale copied runtime files now owned by plugins unless they are intentional overrides.
20+
5. Run upgrade checks:
21+
22+
```bash
23+
bundle exec al-folio upgrade audit --no-fail
24+
bundle exec al-folio upgrade overrides audit
25+
```
26+
27+
6. For each stale or unacknowledged override:
28+
29+
```bash
30+
bundle exec al-folio upgrade overrides diff LOCAL_PATH
31+
bundle exec al-folio upgrade overrides accept LOCAL_PATH
32+
```
33+
34+
7. Build and inspect key pages: home, CV, publications, repositories, projects, posts, and any custom routes.
35+
36+
## Migration Notes
37+
38+
Commit `.al-folio-overrides.yml` when the site intentionally keeps local overrides. It records the upstream plugin file checksum last reviewed so future gem updates can flag drift explicitly.
39+
40+
## Handoff
41+
42+
Report removed stale runtime files, retained local overrides, unresolved visual differences, and exact validation commands.

‎.claude/skills‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../.agents/skills

‎.codex/skills‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../.agents/skills

‎.devcontainer/Dockerfile‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
FROM mcr.microsoft.com/devcontainers/jekyll
2+
3+
# Fix: Remove the broken Yarn repository from the apt sources.
4+
# This prevents 'apt-get update' from failing due to the missing GPG key.
5+
# (Yarn is already provided by the dev container features/nvm, so this system repo is unnecessary)
6+
# See issue #3487
7+
RUN rm -f /etc/apt/sources.list.d/yarn.list

‎.devcontainer/devcontainer.json‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22
// README at: https://github.com/devcontainers/templates/tree/main/src/jekyll
33
{
44
"name": "Jekyll",
5-
"image": "mcr.microsoft.com/devcontainers/jekyll",
5+
// Using a Dockerfile to fix the broken Yarn repository. See issue #3487.
6+
"build": {
7+
"dockerfile": "Dockerfile"
8+
},
69

710
// Features to add to the dev container. More info: https://containers.dev/features.
811
"features": {

‎.gemini/settings.json‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"context": {
3+
"fileName": [
4+
"AGENTS.md",
5+
".github/copilot-instructions.md",
6+
".github/agents/customize.agent.md",
7+
".github/agents/docs.agent.md",
8+
".github/instructions/**/*.md",
9+
"docs/README.md",
10+
"docs/CUSTOMIZE.md",
11+
"docs/INSTALL.md",
12+
"docs/TROUBLESHOOTING.md",
13+
"docs/QUICKSTART.md",
14+
"docs/BOUNDARIES.md"
15+
]
16+
}
17+
}

‎.github/GIT_WORKFLOW.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Git Workflow
2+
3+
This document outlines the conventions for using Git and writing commit messages in this project.
4+
5+
## Commit Message Format
6+
7+
All commit messages should follow this format:
8+
9+
```
10+
<type>: <subject>
11+
12+
<body (optional)>
13+
```
14+
15+
**Types:**
16+
17+
- `feat`: A new feature
18+
- `fix`: A bug fix
19+
- `docs`: Documentation only changes
20+
- `style`: Changes that do not affect the meaning of the code (white-space, formatting, etc.)
21+
- `config`: Changes to configuration files
22+
- `chore`: Changes to the build process or auxiliary tools and libraries
23+
24+
**Examples:**
25+
26+
```
27+
feat: Add dark mode toggle button to header
28+
fix: Correct baseurl in project site configuration
29+
docs: Update docs/INSTALL.md with Docker troubleshooting
30+
style: Format all Liquid templates with Prettier
31+
config: Enable blog section in _config.yml
32+
chore: Update Jekyll dependencies with bundle update --all
33+
```
34+
35+
## Staging Changes
36+
37+
**Always `git add` files explicitly.** Do not stage everything with `git add .` unless you are certain of what's being committed. Check `git status` first to review your changes.
38+
39+
## What NOT to Commit
40+
41+
**Always obey the project's [`.gitignore`](../.gitignore) file.** It prevents the accidental commit of:
42+
43+
- Build outputs (`_site/`, `.jekyll-cache/`)
44+
- Dependencies (`node_modules/`, `vendor/`)
45+
- OS-specific files (`.DS_store`)
46+
- Editor temporary files (`.idea/`, `.swp`, `.swo`)
47+
- Secrets and API keys (never commit credentials)

‎.github/ISSUE_TEMPLATE/1_bug_report.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ body:
77
value: >
88
Before you go any further. Is this really a **🐛 bug**?
99
10-
If it's a question about how al-folio works, have a look at our [documentation](https://github.com/alshedivat/al-folio/blob/main/README.md),
11-
[frequently asked questions](https://github.com/alshedivat/al-folio/blob/main/FAQ.md),
10+
If it's a question about how al-folio works, have a look at our [documentation](https://github.com/alshedivat/al-folio/blob/main/docs/README.md),
11+
[frequently asked questions](https://github.com/alshedivat/al-folio/blob/main/docs/FAQ.md),
1212
[past questions](https://github.com/alshedivat/al-folio/discussions/categories/q-a),
1313
or [ask a question](https://github.com/alshedivat/al-folio/discussions/new?category=q-a).
1414
@@ -20,7 +20,7 @@ body:
2020
Please check if somebody else has already filed the same issue.
2121
If you find a similar issue, please add a 👍 reaction or comment on the original post.
2222
options:
23-
- label: I read through [FAQ](https://github.com/alshedivat/al-folio/blob/main/FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my issue.
23+
- label: I read through [FAQ](https://github.com/alshedivat/al-folio/blob/main/docs/FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my issue.
2424
required: true
2525
- label: Yes, I have checked that this issue isn't already filed.
2626
required: true

‎.github/ISSUE_TEMPLATE/2_feature_request.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ body:
77
value: >
88
Before you go any further, are you sure that this feature is not already implemented?
99
10-
If it's a question about how al-folio works, have a look at our [documentation](https://github.com/alshedivat/al-folio/blob/main/README.md),
11-
[frequently asked questions](https://github.com/alshedivat/al-folio/blob/main/FAQ.md),
10+
If it's a question about how al-folio works, have a look at our [documentation](https://github.com/alshedivat/al-folio/blob/main/docs/README.md),
11+
[frequently asked questions](https://github.com/alshedivat/al-folio/blob/main/docs/FAQ.md),
1212
[past questions](https://github.com/alshedivat/al-folio/discussions/categories/q-a),
1313
or [ask a question](https://github.com/alshedivat/al-folio/discussions/new?category=q-a).
1414
@@ -20,7 +20,7 @@ body:
2020
Please check if somebody else has already filed the same 🚀 feature request.
2121
If you find a similar feature request, please add a 👍 reaction or comment on the original post.
2222
options:
23-
- label: I read through [FAQ](https://github.com/alshedivat/al-folio/blob/main/FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my feature request.
23+
- label: I read through [FAQ](https://github.com/alshedivat/al-folio/blob/main/docs/FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my feature request.
2424
required: true
2525
- label: Yes, I have checked that this feature request isn't already filed.
2626
required: true

0 commit comments

Comments
 (0)