From c3937ee28f30502daaea2512ec268800415c75b6 Mon Sep 17 00:00:00 2001 From: Ted Apel Date: Wed, 21 Oct 2026 20:49:11 -0600 Subject: [PATCH 1/4] Migrate to al-folio v1.2 plugin architecture Runtime now comes from the al_folio_core gem and its sibling plugins, so the site no longer carries its own copies of the theme's includes, layouts, Sass, scripts, fonts, or vendored JS/CSS. Starter wiring (Gemfile, _config.yml, purgecss, bin/, workflows, package.json) is taken from the v1.2 starter and configured for vud.org. Local overrides kept, each the gem's file plus the site's change, and acknowledged in .al-folio-overrides.yml: - header.liquid: vud.svg logo in the navbar - projects.liquid: h4 card titles - video.liquid: responsive 16:9 iframe wrapper - bib.liquid: Google Scholar badge link fix - courses.liquid, repository/repo.liquid: simplified lists - assets/css/main.scss + _sass/_custom.scss: social icon size and repository card styles The apple-touch-icon override is gone; the gem reads apple_touch_icon from _config.yml instead. --- .al-folio-overrides.yml | 52 + .github/workflows/broken-links.yml | 5 +- .github/workflows/deploy.yml | 27 +- .github/workflows/update-tocs.yml | 28 +- .github/workflows/upgrade-check.yml | 59 + .gitignore | 3 + .prettierignore | 7 +- CONTRIBUTING.md | 86 - FAQ.md | 180 - Gemfile | 29 +- INSTALL.md | 283 - _config.yml | 263 +- _includes/audio.liquid | 30 - _includes/bib_search.liquid | 4 - _includes/calendar.liquid | 25 - _includes/citation.liquid | 26 - _includes/course_schedule.liquid | 71 - _includes/cv/list.liquid | 5 - _includes/cv/list_groups.liquid | 51 - _includes/cv/map.liquid | 29 - _includes/cv/nested_list.liquid | 16 - _includes/cv/time_table.liquid | 118 - _includes/disqus.liquid | 13 - _includes/distill_scripts.liquid | 294 - _includes/figure.liquid | 86 - _includes/footer.liquid | 30 - _includes/giscus.liquid | 25 - _includes/head.liquid | 190 - _includes/header.liquid | 23 +- _includes/latest_posts.liquid | 48 - _includes/metadata.liquid | 247 - _includes/news.liquid | 34 - _includes/newsletter.liquid | 68 - _includes/pagination.liquid | 21 - _includes/projects_horizontal.liquid | 34 - _includes/related_posts.liquid | 36 - _includes/repository/repo_trophies.liquid | 42 - _includes/repository/repo_user.liquid | 34 - _includes/resume/awards.liquid | 19 - _includes/resume/basics.liquid | 28 - _includes/resume/certificates.liquid | 35 - _includes/resume/education.liquid | 54 - _includes/resume/interests.liquid | 34 - _includes/resume/languages.liquid | 31 - _includes/resume/projects.liquid | 32 - _includes/resume/publications.liquid | 28 - _includes/resume/references.liquid | 31 - _includes/resume/skills.liquid | 33 - _includes/resume/volunteer.liquid | 52 - _includes/resume/work.liquid | 52 - _includes/scripts.liquid | 332 - _includes/selected_papers.liquid | 3 - _includes/video.liquid | 9 +- _layouts/about.liquid | 80 - _layouts/archive.liquid | 38 - _layouts/bib.liquid | 26 +- _layouts/book-review.liquid | 257 - _layouts/book-shelf.liquid | 49 - _layouts/course.liquid | 75 - _layouts/cv.liquid | 127 - _layouts/default.liquid | 56 - _layouts/distill.liquid | 131 - _layouts/none.liquid | 1 - _layouts/page.liquid | 31 - _layouts/post.liquid | 96 - _layouts/profiles.liquid | 36 - _music/.template.md | 20 - _plugins/details.rb | 23 - _plugins/external-posts.rb | 124 - _plugins/file-exists.rb | 22 - _plugins/google-scholar-citations.rb | 86 - _plugins/hide-custom-bibtex.rb | 18 - _plugins/inspirehep-citations.rb | 57 - _plugins/remove-accents.rb | 32 - _sass/_base.scss | 1610 -- _sass/_custom.scss | 94 + _sass/_cv.scss | 220 - _sass/_distill.scss | 185 - _sass/_layout.scss | 53 - _sass/_tabs.scss | 48 - _sass/_teachings.scss | 77 - _sass/_themes.scss | 161 - _sass/_typograms.scss | 132 - _sass/_variables.scss | 52 - _sass/font-awesome/_animated.scss | 152 - _sass/font-awesome/_bordered-pulled.scss | 20 - _sass/font-awesome/_core.scss | 49 - _sass/font-awesome/_fixed-width.scss | 7 - _sass/font-awesome/_functions.scss | 57 - _sass/font-awesome/_icons.scss | 13 - _sass/font-awesome/_list.scss | 18 - _sass/font-awesome/_mixins.scss | 65 - _sass/font-awesome/_rotated-flipped.scss | 31 - _sass/font-awesome/_screen-reader.scss | 14 - _sass/font-awesome/_shims.scss | 1578 -- _sass/font-awesome/_sizing.scss | 16 - _sass/font-awesome/_stacked.scss | 32 - _sass/font-awesome/_variables.scss | 5044 ------ _sass/font-awesome/brands.scss | 30 - _sass/font-awesome/fontawesome.scss | 21 - _sass/font-awesome/regular.scss | 27 - _sass/font-awesome/solid.scss | 27 - _sass/font-awesome/v4-shims.scss | 11 - _sass/tabler-icons/tabler-icons-filled.scss | 1646 -- _sass/tabler-icons/tabler-icons-outline.scss | 9859 ----------- _sass/tabler-icons/tabler-icons.scss | 11463 ------------ _scripts/cronitor-analytics-setup.js | 9 - _scripts/giscus-setup.js | 48 - _scripts/google-analytics-setup.js | 9 - _scripts/open-panel-analytics-setup.js | 14 - _scripts/photoswipe-setup.js | 11 - _scripts/search.liquid.js | 341 - assets/css/academicons.min.css | 1 - assets/css/bootstrap-toc.min.css | 4 - assets/css/bootstrap.min.css | 7 - assets/css/bootstrap.min.css.map | 1 - assets/css/jekyll-pygments-themes-github.css | 209 - assets/css/jekyll-pygments-themes-native.css | 232 - assets/css/jupyter-grade3.css | 3758 ---- assets/css/jupyter-monokai.css | 3758 ---- assets/css/jupyter.css | 383 - assets/css/main.scss | 50 +- assets/css/mdb.min.css | 48 - assets/css/mdb.min.css.map | 1 - assets/css/scholar-icons.css | 386 - assets/fonts/academicons.ttf | Bin 67872 -> 0 bytes assets/fonts/academicons.woff | Bin 131616 -> 0 bytes assets/fonts/scholar-icons.ttf | Bin 103460 -> 0 bytes assets/fonts/scholar-icons.woff | Bin 103536 -> 0 bytes assets/fonts/tabler-icons-filled.ttf | Bin 260148 -> 0 bytes assets/fonts/tabler-icons-filled.woff | Bin 130096 -> 0 bytes assets/fonts/tabler-icons-filled.woff2 | Bin 103616 -> 0 bytes assets/fonts/tabler-icons-outline.ttf | Bin 2205192 -> 0 bytes assets/fonts/tabler-icons-outline.woff | Bin 1102996 -> 0 bytes assets/fonts/tabler-icons-outline.woff2 | Bin 773144 -> 0 bytes assets/fonts/tabler-icons.ttf | Bin 2479088 -> 0 bytes assets/fonts/tabler-icons.woff | Bin 1234424 -> 0 bytes assets/fonts/tabler-icons.woff2 | Bin 867452 -> 0 bytes assets/js/bibsearch.js | 70 - assets/js/bootstrap-toc.min.js | 5 - assets/js/bootstrap.bundle.min.js | 7 - assets/js/bootstrap.bundle.min.js.map | 1 - assets/js/calendar-setup.js | 16 - assets/js/chartjs-setup.js | 14 - assets/js/common.js | 60 - assets/js/copy_code.js | 56 - assets/js/diff2html-setup.js | 20 - assets/js/distillpub/overrides.js | 27 - assets/js/distillpub/template.v2.js | 9616 ---------- assets/js/distillpub/template.v2.js.map | 1 - assets/js/distillpub/transforms.v2.js | 14557 ---------------- assets/js/distillpub/transforms.v2.js.map | 1 - assets/js/echarts-setup.js | 29 - assets/js/highlight-search-term.js | 110 - assets/js/jupyter_new_tab.js | 18 - assets/js/leaflet-setup.js | 22 - assets/js/masonry.js | 12 - assets/js/mathjax-setup.js | 26 - assets/js/mermaid-setup.js | 37 - assets/js/newsletter.js | 105 - assets/js/no_defer.js | 24 - assets/js/plotly-setup.js | 52 - assets/js/progress-bar.js | 73 - assets/js/pseudocode-setup.js | 33 - assets/js/search-setup.js | 17 - assets/js/search/base-styles.min.js | 286 - assets/js/search/command-score.min.js | 7 - .../js/search/hotkeys-js/hotkeys.esm.min.js | 18 - .../js/search/lit-element/lit-element.min.js | 12 - .../lit-html/directives/class-map.min.js | 22 - .../js/search/lit-html/directives/join.min.js | 12 - .../js/search/lit-html/directives/live.min.js | 28 - .../js/search/lit-html/directives/ref.min.js | 32 - .../search/lit-html/directives/repeat.min.js | 27 - .../lit-html/directives/unsafe-html.min.js | 22 - assets/js/search/lit-html/is-server.min.js | 12 - assets/js/search/lit-html/lit-html.min.js | 12 - assets/js/search/lit/decorators.min.js | 7 - .../js/search/lit/directives/class-map.min.js | 7 - assets/js/search/lit/directives/join.min.js | 7 - assets/js/search/lit/directives/live.min.js | 7 - assets/js/search/lit/directives/ref.min.js | 7 - assets/js/search/lit/directives/repeat.min.js | 7 - .../search/lit/directives/unsafe-html.min.js | 7 - assets/js/search/lit/index.min.js | 7 - assets/js/search/ninja-action.min.js | 101 - assets/js/search/ninja-footer.min.js | 62 - assets/js/search/ninja-header.min.js | 78 - assets/js/search/ninja-keys.min.js | 39 - .../decorators/custom-element.min.js | 12 - .../decorators/event-options.min.js | 12 - .../decorators/property.min.js | 22 - .../decorators/query-all.min.js | 17 - .../decorators/query-assigned-elements.min.js | 17 - .../decorators/query-assigned-nodes.min.js | 17 - .../decorators/query-async.min.js | 17 - .../reactive-element/decorators/query.min.js | 17 - .../reactive-element/decorators/state.min.js | 27 - .../reactive-element/reactive-element.min.js | 17 - assets/js/shortcut-key.js | 11 - assets/js/tabs.min.js | 5 - assets/js/theme.js | 329 - assets/js/tooltips-setup.js | 3 - assets/js/typograms.js | 1341 -- assets/js/vanilla-back-to-top.min.js | 1 - assets/js/vega-setup.js | 24 - assets/js/venobox-setup.js | 5 - assets/js/wechat.js | 14 - assets/js/zoom.js | 6 - assets/webfonts/fa-brands-400.ttf | Bin 210736 -> 0 bytes assets/webfonts/fa-brands-400.woff2 | Bin 118724 -> 0 bytes assets/webfonts/fa-regular-400.ttf | Bin 68064 -> 0 bytes assets/webfonts/fa-regular-400.woff2 | Bin 25484 -> 0 bytes assets/webfonts/fa-solid-900.ttf | Bin 426112 -> 0 bytes assets/webfonts/fa-solid-900.woff2 | Bin 158224 -> 0 bytes assets/webfonts/fa-v4compatibility.ttf | Bin 10836 -> 0 bytes assets/webfonts/fa-v4compatibility.woff2 | Bin 4788 -> 0 bytes bin/al-folio | 4 + bin/entry_point.sh | 17 +- bin/setup-python-deps | 9 + docker-compose.yml | 3 +- package-lock.json | 89 + package.json | 9 + purgecss.config.js | 21 + requirements.txt | 4 +- 225 files changed, 650 insertions(+), 74117 deletions(-) create mode 100644 .al-folio-overrides.yml create mode 100644 .github/workflows/upgrade-check.yml delete mode 100644 CONTRIBUTING.md delete mode 100644 FAQ.md delete mode 100644 INSTALL.md delete mode 100644 _includes/audio.liquid delete mode 100644 _includes/bib_search.liquid delete mode 100644 _includes/calendar.liquid delete mode 100644 _includes/citation.liquid delete mode 100644 _includes/course_schedule.liquid delete mode 100644 _includes/cv/list.liquid delete mode 100644 _includes/cv/list_groups.liquid delete mode 100644 _includes/cv/map.liquid delete mode 100644 _includes/cv/nested_list.liquid delete mode 100644 _includes/cv/time_table.liquid delete mode 100644 _includes/disqus.liquid delete mode 100644 _includes/distill_scripts.liquid delete mode 100644 _includes/figure.liquid delete mode 100644 _includes/footer.liquid delete mode 100644 _includes/giscus.liquid delete mode 100644 _includes/head.liquid delete mode 100644 _includes/latest_posts.liquid delete mode 100644 _includes/metadata.liquid delete mode 100644 _includes/news.liquid delete mode 100644 _includes/newsletter.liquid delete mode 100644 _includes/pagination.liquid delete mode 100644 _includes/projects_horizontal.liquid delete mode 100644 _includes/related_posts.liquid delete mode 100644 _includes/repository/repo_trophies.liquid delete mode 100644 _includes/repository/repo_user.liquid delete mode 100644 _includes/resume/awards.liquid delete mode 100644 _includes/resume/basics.liquid delete mode 100644 _includes/resume/certificates.liquid delete mode 100644 _includes/resume/education.liquid delete mode 100644 _includes/resume/interests.liquid delete mode 100644 _includes/resume/languages.liquid delete mode 100644 _includes/resume/projects.liquid delete mode 100644 _includes/resume/publications.liquid delete mode 100644 _includes/resume/references.liquid delete mode 100644 _includes/resume/skills.liquid delete mode 100644 _includes/resume/volunteer.liquid delete mode 100644 _includes/resume/work.liquid delete mode 100644 _includes/scripts.liquid delete mode 100644 _includes/selected_papers.liquid delete mode 100644 _layouts/about.liquid delete mode 100644 _layouts/archive.liquid delete mode 100644 _layouts/book-review.liquid delete mode 100644 _layouts/book-shelf.liquid delete mode 100644 _layouts/course.liquid delete mode 100644 _layouts/cv.liquid delete mode 100644 _layouts/default.liquid delete mode 100644 _layouts/distill.liquid delete mode 100644 _layouts/none.liquid delete mode 100644 _layouts/page.liquid delete mode 100644 _layouts/post.liquid delete mode 100644 _layouts/profiles.liquid delete mode 100644 _music/.template.md delete mode 100644 _plugins/details.rb delete mode 100644 _plugins/external-posts.rb delete mode 100644 _plugins/file-exists.rb delete mode 100644 _plugins/google-scholar-citations.rb delete mode 100644 _plugins/hide-custom-bibtex.rb delete mode 100644 _plugins/inspirehep-citations.rb delete mode 100644 _plugins/remove-accents.rb delete mode 100644 _sass/_base.scss create mode 100644 _sass/_custom.scss delete mode 100644 _sass/_cv.scss delete mode 100644 _sass/_distill.scss delete mode 100644 _sass/_layout.scss delete mode 100644 _sass/_tabs.scss delete mode 100644 _sass/_teachings.scss delete mode 100644 _sass/_themes.scss delete mode 100644 _sass/_typograms.scss delete mode 100644 _sass/_variables.scss delete mode 100644 _sass/font-awesome/_animated.scss delete mode 100644 _sass/font-awesome/_bordered-pulled.scss delete mode 100644 _sass/font-awesome/_core.scss delete mode 100644 _sass/font-awesome/_fixed-width.scss delete mode 100644 _sass/font-awesome/_functions.scss delete mode 100644 _sass/font-awesome/_icons.scss delete mode 100644 _sass/font-awesome/_list.scss delete mode 100644 _sass/font-awesome/_mixins.scss delete mode 100644 _sass/font-awesome/_rotated-flipped.scss delete mode 100644 _sass/font-awesome/_screen-reader.scss delete mode 100644 _sass/font-awesome/_shims.scss delete mode 100644 _sass/font-awesome/_sizing.scss delete mode 100644 _sass/font-awesome/_stacked.scss delete mode 100644 _sass/font-awesome/_variables.scss delete mode 100644 _sass/font-awesome/brands.scss delete mode 100644 _sass/font-awesome/fontawesome.scss delete mode 100644 _sass/font-awesome/regular.scss delete mode 100644 _sass/font-awesome/solid.scss delete mode 100644 _sass/font-awesome/v4-shims.scss delete mode 100644 _sass/tabler-icons/tabler-icons-filled.scss delete mode 100644 _sass/tabler-icons/tabler-icons-outline.scss delete mode 100644 _sass/tabler-icons/tabler-icons.scss delete mode 100644 _scripts/cronitor-analytics-setup.js delete mode 100644 _scripts/giscus-setup.js delete mode 100644 _scripts/google-analytics-setup.js delete mode 100644 _scripts/open-panel-analytics-setup.js delete mode 100644 _scripts/photoswipe-setup.js delete mode 100644 _scripts/search.liquid.js delete mode 100644 assets/css/academicons.min.css delete mode 100644 assets/css/bootstrap-toc.min.css delete mode 100644 assets/css/bootstrap.min.css delete mode 100644 assets/css/bootstrap.min.css.map delete mode 100644 assets/css/jekyll-pygments-themes-github.css delete mode 100644 assets/css/jekyll-pygments-themes-native.css delete mode 100644 assets/css/jupyter-grade3.css delete mode 100644 assets/css/jupyter-monokai.css delete mode 100644 assets/css/jupyter.css delete mode 100644 assets/css/mdb.min.css delete mode 100644 assets/css/mdb.min.css.map delete mode 100644 assets/css/scholar-icons.css delete mode 100644 assets/fonts/academicons.ttf delete mode 100644 assets/fonts/academicons.woff delete mode 100644 assets/fonts/scholar-icons.ttf delete mode 100644 assets/fonts/scholar-icons.woff delete mode 100644 assets/fonts/tabler-icons-filled.ttf delete mode 100644 assets/fonts/tabler-icons-filled.woff delete mode 100644 assets/fonts/tabler-icons-filled.woff2 delete mode 100644 assets/fonts/tabler-icons-outline.ttf delete mode 100644 assets/fonts/tabler-icons-outline.woff delete mode 100644 assets/fonts/tabler-icons-outline.woff2 delete mode 100644 assets/fonts/tabler-icons.ttf delete mode 100644 assets/fonts/tabler-icons.woff delete mode 100644 assets/fonts/tabler-icons.woff2 delete mode 100644 assets/js/bibsearch.js delete mode 100644 assets/js/bootstrap-toc.min.js delete mode 100644 assets/js/bootstrap.bundle.min.js delete mode 100644 assets/js/bootstrap.bundle.min.js.map delete mode 100644 assets/js/calendar-setup.js delete mode 100644 assets/js/chartjs-setup.js delete mode 100644 assets/js/common.js delete mode 100644 assets/js/copy_code.js delete mode 100644 assets/js/diff2html-setup.js delete mode 100644 assets/js/distillpub/overrides.js delete mode 100644 assets/js/distillpub/template.v2.js delete mode 100644 assets/js/distillpub/template.v2.js.map delete mode 100644 assets/js/distillpub/transforms.v2.js delete mode 100644 assets/js/distillpub/transforms.v2.js.map delete mode 100644 assets/js/echarts-setup.js delete mode 100644 assets/js/highlight-search-term.js delete mode 100644 assets/js/jupyter_new_tab.js delete mode 100644 assets/js/leaflet-setup.js delete mode 100644 assets/js/masonry.js delete mode 100644 assets/js/mathjax-setup.js delete mode 100644 assets/js/mermaid-setup.js delete mode 100644 assets/js/newsletter.js delete mode 100644 assets/js/no_defer.js delete mode 100644 assets/js/plotly-setup.js delete mode 100644 assets/js/progress-bar.js delete mode 100644 assets/js/pseudocode-setup.js delete mode 100644 assets/js/search-setup.js delete mode 100644 assets/js/search/base-styles.min.js delete mode 100644 assets/js/search/command-score.min.js delete mode 100644 assets/js/search/hotkeys-js/hotkeys.esm.min.js delete mode 100644 assets/js/search/lit-element/lit-element.min.js delete mode 100644 assets/js/search/lit-html/directives/class-map.min.js delete mode 100644 assets/js/search/lit-html/directives/join.min.js delete mode 100644 assets/js/search/lit-html/directives/live.min.js delete mode 100644 assets/js/search/lit-html/directives/ref.min.js delete mode 100644 assets/js/search/lit-html/directives/repeat.min.js delete mode 100644 assets/js/search/lit-html/directives/unsafe-html.min.js delete mode 100644 assets/js/search/lit-html/is-server.min.js delete mode 100644 assets/js/search/lit-html/lit-html.min.js delete mode 100644 assets/js/search/lit/decorators.min.js delete mode 100644 assets/js/search/lit/directives/class-map.min.js delete mode 100644 assets/js/search/lit/directives/join.min.js delete mode 100644 assets/js/search/lit/directives/live.min.js delete mode 100644 assets/js/search/lit/directives/ref.min.js delete mode 100644 assets/js/search/lit/directives/repeat.min.js delete mode 100644 assets/js/search/lit/directives/unsafe-html.min.js delete mode 100644 assets/js/search/lit/index.min.js delete mode 100644 assets/js/search/ninja-action.min.js delete mode 100644 assets/js/search/ninja-footer.min.js delete mode 100644 assets/js/search/ninja-header.min.js delete mode 100644 assets/js/search/ninja-keys.min.js delete mode 100644 assets/js/search/reactive-element/decorators/custom-element.min.js delete mode 100644 assets/js/search/reactive-element/decorators/event-options.min.js delete mode 100644 assets/js/search/reactive-element/decorators/property.min.js delete mode 100644 assets/js/search/reactive-element/decorators/query-all.min.js delete mode 100644 assets/js/search/reactive-element/decorators/query-assigned-elements.min.js delete mode 100644 assets/js/search/reactive-element/decorators/query-assigned-nodes.min.js delete mode 100644 assets/js/search/reactive-element/decorators/query-async.min.js delete mode 100644 assets/js/search/reactive-element/decorators/query.min.js delete mode 100644 assets/js/search/reactive-element/decorators/state.min.js delete mode 100644 assets/js/search/reactive-element/reactive-element.min.js delete mode 100644 assets/js/shortcut-key.js delete mode 100644 assets/js/tabs.min.js delete mode 100644 assets/js/theme.js delete mode 100644 assets/js/tooltips-setup.js delete mode 100644 assets/js/typograms.js delete mode 100644 assets/js/vanilla-back-to-top.min.js delete mode 100644 assets/js/vega-setup.js delete mode 100644 assets/js/venobox-setup.js delete mode 100644 assets/js/wechat.js delete mode 100644 assets/js/zoom.js delete mode 100644 assets/webfonts/fa-brands-400.ttf delete mode 100644 assets/webfonts/fa-brands-400.woff2 delete mode 100644 assets/webfonts/fa-regular-400.ttf delete mode 100644 assets/webfonts/fa-regular-400.woff2 delete mode 100644 assets/webfonts/fa-solid-900.ttf delete mode 100644 assets/webfonts/fa-solid-900.woff2 delete mode 100644 assets/webfonts/fa-v4compatibility.ttf delete mode 100644 assets/webfonts/fa-v4compatibility.woff2 create mode 100755 bin/al-folio create mode 100755 bin/setup-python-deps diff --git a/.al-folio-overrides.yml b/.al-folio-overrides.yml new file mode 100644 index 00000000..116fefb2 --- /dev/null +++ b/.al-folio-overrides.yml @@ -0,0 +1,52 @@ +--- +version: 1 +overrides: + _includes/courses.liquid: + owner: al_folio_core + gem_version: 1.0.15 + upstream_path: _includes/courses.liquid + upstream_sha256: b302f66998945adce1c1bdd396a0123236e4c6b68d198f8bc092e4334b9d10fd + local_sha256: f2ce85b464a8356048760309f6cf35a0aaf34996f7cec776ef6f9ca5f6b05a78 + acknowledged_at: '2026-10-21' + _includes/header.liquid: + owner: al_folio_core + gem_version: 1.0.15 + upstream_path: _includes/header.liquid + upstream_sha256: c8663513baded68d9fa5fbe4d6363a976535bbe201efe5138243d0ff03101058 + local_sha256: c50c16b59f766a457851a638fbfb0c1202c6ae5494940264181e1372e4c5047b + acknowledged_at: '2026-10-21' + _includes/projects.liquid: + owner: al_folio_core + gem_version: 1.0.15 + upstream_path: _includes/projects.liquid + upstream_sha256: b824fbc63e1fe9cda6280f482ec51db4e6fcbfbbf4e27f55e728664dab9d4f6e + local_sha256: 067c97bc55c1c2a796e02f53a439da0708f7cf1ece6b72fee87323db1188cf8f + acknowledged_at: '2026-10-21' + _includes/repository/repo.liquid: + owner: al_folio_core + gem_version: 1.0.15 + upstream_path: _includes/repository/repo.liquid + upstream_sha256: ce87ac70cb6a8e2b1ed708b0418c638ebc4e59c4198de68bff0fc39cd5a01087 + local_sha256: b0379748df59adba6ad5a58758a398d78fb339bfe4573fd50f6765377d563849 + acknowledged_at: '2026-10-21' + _includes/video.liquid: + owner: al_folio_core + gem_version: 1.0.15 + upstream_path: _includes/video.liquid + upstream_sha256: 787adbfbcbd4b99982a6587ee8c5a36817c5699baf07a06b005a904532de86e4 + local_sha256: 5edcffe10d07947037116a50f177703a106d93fee967e76305363e1d01b82669 + acknowledged_at: '2026-10-21' + _layouts/bib.liquid: + owner: al_folio_core + gem_version: 1.0.15 + upstream_path: _layouts/bib.liquid + upstream_sha256: f3c547969ef76219ca1eb21df09dce5a3daf32a1f491b1586f68e3213fa35f53 + local_sha256: 32a4010d5e303655c3af95f3aaff1f35d853297be74fb70fdbe7b218cc87fb61 + acknowledged_at: '2026-10-21' + assets/css/main.scss: + owner: al_folio_core + gem_version: 1.0.15 + upstream_path: assets/css/main.scss + upstream_sha256: 437c6c911c596391413e435dc0ea7095e682e85c572c1fd3fff69f9597455b3e + local_sha256: a848a0402a82ccec46b751f3184d53602352cb5bf9c6b0e3ff4b21ef4add9c21 + acknowledged_at: '2026-10-21' diff --git a/.github/workflows/broken-links.yml b/.github/workflows/broken-links.yml index d23c0117..44b794fe 100644 --- a/.github/workflows/broken-links.yml +++ b/.github/workflows/broken-links.yml @@ -51,4 +51,7 @@ jobs: with: fail: true # removed md files that include liquid tags - args: --user-agent 'curl/7.54' --exclude-path README.md --exclude-path _pages/404.md --exclude-path _pages/blog.md --exclude-path _posts/2018-12-22-distill.md --exclude-path _posts/2023-04-24-videos.md --exclude-path _books/the_godfather.md --verbose --no-progress './**/*.md' './**/*.html' + # docs/releases is excluded because release notes link to the compare + # range for the tag they are about to create, which cannot resolve until + # the release is published + args: --user-agent 'curl/7.54' --max-retries 3 --retry-wait-time 2 --exclude-path docs/releases --exclude-path README.md --exclude-path _pages/404.md --exclude-path _pages/blog.md --exclude-path _posts/2018-12-22-distill.md --exclude-path _posts/2023-04-24-videos.md --exclude-path _books/the_godfather.md --exclude-path .github/instructions/bibtex-bibliography.instructions.md --exclude-path .github/instructions/yaml-configuration.instructions.md --exclude-path .github/instructions/markdown-content.instructions.md --exclude-path .github/instructions/liquid-templates.instructions.md --exclude-path AGENTS.md --exclude-path docs/SEO.md --exclude-path docs/SHOWCASE.md --verbose --no-progress './**/*.md' './**/*.html' diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 83dc05ed..25c9c87f 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -7,8 +7,6 @@ on: - main paths: - "assets/**" - - "_sass/**" - - "_scripts/**" - "**.bib" - "**.html" - "**.js" @@ -26,10 +24,10 @@ on: - "!.github/workflows/lighthouse-badger.yml" - "!.github/workflows/prettier.yml" - "!lighthouse_results/**" - - "!CONTRIBUTING.md" - - "!CUSTOMIZE.md" - - "!FAQ.md" - - "!INSTALL.md" + - "!docs/CONTRIBUTING.md" + - "!docs/CUSTOMIZE.md" + - "!docs/FAQ.md" + - "!docs/INSTALL.md" - "!README.md" pull_request: branches: @@ -37,8 +35,6 @@ on: - main paths: - "assets/**" - - "_sass/**" - - "_scripts/**" - "**.bib" - "**.html" - "**.js" @@ -56,10 +52,10 @@ on: - "!.github/workflows/lighthouse-badger.yml" - "!.github/workflows/prettier.yml" - "!lighthouse_results/**" - - "!CONTRIBUTING.md" - - "!CUSTOMIZE.md" - - "!FAQ.md" - - "!INSTALL.md" + - "!docs/CONTRIBUTING.md" + - "!docs/CUSTOMIZE.md" + - "!docs/FAQ.md" + - "!docs/INSTALL.md" - "!README.md" workflow_dispatch: @@ -83,6 +79,13 @@ jobs: with: python-version: "3.13" cache: "pip" # caching pip dependencies + - name: Setup Node ๐Ÿงฐ + uses: actions/setup-node@v4 + with: + node-version: "20" + cache: "npm" + - name: Install JS deps ๐Ÿ“ฆ + run: npm ci - name: Update _config.yml โš™๏ธ uses: fjogeleit/yaml-update-action@main with: diff --git a/.github/workflows/update-tocs.yml b/.github/workflows/update-tocs.yml index 3567ee82..5bad0fb7 100644 --- a/.github/workflows/update-tocs.yml +++ b/.github/workflows/update-tocs.yml @@ -8,6 +8,7 @@ on: - master paths: - "*.md" + - "docs/*.md" workflow_dispatch: permissions: @@ -22,11 +23,15 @@ jobs: with: fetch-depth: 0 # OR "2" -> To retrieve the preceding commit. + - uses: actions/setup-node@v4 + - name: Get changed files id: changed-files uses: tj-actions/changed-files@ed68ef82c095e0d48ec87eccea555d944a631a4c # v46 with: - files: ./*.md + files: | + ./*.md + docs/*.md - name: Updated toc on all markdown changed files env: @@ -43,6 +48,27 @@ jobs: done rm gh-md-toc + # gh-md-toc and Prettier disagree about escaping in link text: the TOC + # generator emits `_config.yml` where Prettier requires `\_config.yml`. + # Without this step the auto-commit lands unformatted and prettier.yml + # immediately goes red on main. Prettier gets the last word. + - name: Normalize TOC formatting ๐ŸŽจ + env: + ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }} + run: | + # `npm ci` installs from the lockfile and does not touch package.json or + # package-lock.json. `npm install --save-dev` would rewrite the caret + # ranges to exact pins and upgrade them, and because the auto-commit step + # below sets no file_pattern (default `.`), those dependency changes would + # be committed to main under the message "Auto update markdown TOC". + npm ci + for file in ${ALL_CHANGED_FILES}; do + if [[ "$file" != *.md ]]; then + continue + fi + npx prettier --write "$file" + done + - name: Commit changes if: steps.changed-files.outputs.any_changed == 'true' uses: stefanzweifel/git-auto-commit-action@v5.0.1 diff --git a/.github/workflows/upgrade-check.yml b/.github/workflows/upgrade-check.yml new file mode 100644 index 00000000..77524b7b --- /dev/null +++ b/.github/workflows/upgrade-check.yml @@ -0,0 +1,59 @@ +name: Upgrade contract checks + +on: + push: + branches: + - master + - main + - v1.0-dev + paths: + - "_config.yml" + - "_data/**" + - "_pages/**" + - "_posts/**" + - "_projects/**" + - "assets/**" + - "Gemfile" + - "Gemfile.lock" + - "test/integration_upgrade_cli.sh" + - ".github/workflows/upgrade-check.yml" + pull_request: + branches: + - master + - main + - v1.0-dev + paths: + - "_config.yml" + - "_data/**" + - "_pages/**" + - "_posts/**" + - "_projects/**" + - "assets/**" + - "Gemfile" + - "Gemfile.lock" + - "test/integration_upgrade_cli.sh" + - ".github/workflows/upgrade-check.yml" + +jobs: + upgrade-check: + runs-on: ubuntu-latest + steps: + - name: Checkout ๐Ÿ›Ž๏ธ + uses: actions/checkout@v4 + + - name: Setup Ruby ๐Ÿ’Ž + uses: ruby/setup-ruby@v1 + with: + ruby-version: "3.3.5" + bundler-cache: true + + - name: Run upgrade audit ๐Ÿงช + run: bundle exec al-folio upgrade audit + + - name: Upload upgrade report ๐Ÿ“„ + if: always() + uses: actions/upload-artifact@v4 + with: + name: al-folio-upgrade-report + path: al-folio-upgrade-report.md + if-no-files-found: ignore diff --git a/.gitignore b/.gitignore index 759f824d..c3ddbdb0 100644 --- a/.gitignore +++ b/.gitignore @@ -15,3 +15,6 @@ vendor context/ CLAUDE.md .claude/ +al-folio-upgrade-report.md +__pycache__/ +*.pyc diff --git a/.prettierignore b/.prettierignore index ed2331ef..fbe8d258 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,14 +1,9 @@ **/*.map **/*.min.css **/*.min.js -assets/css/main.scss -assets/js/distillpub/template.v2.js -assets/js/search/*.js assets/plotly/demo.html lighthouse_results/** _posts/2015-10-20-math.md -_sass/font-awesome/*.scss -_sass/tabler-icons/*.scss -_scripts/* # Ignore citation YAML file generated by script _data/citations.yml +assets/css/main.scss diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 6c84f249..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,86 +0,0 @@ -# Contributing to al-folio - -Thank you for considering contributing to al-folio! - -## Pull Requests - -We welcome your pull requests (PRs). -For minor fixes (e.g., documentation improvements), feel free to submit a PR directly. -If you would like to implement a new feature or a bug, please make sure you (or someone else) has opened an appropriate issue first; in your PR, please mention the issue it addresses. - -Note that since [#2048](https://github.com/alshedivat/al-folio/pull/2048) al-folio uses the [prettier formatter](https://prettier.io/) for its code, meaning all new submitted code must conform to its standard. If you don't have `prettier` installed for your setup and the `prettier` code check fails when submitting a PR, you can check the referred failed action in our repo. In that action there will be an artifact with an HTML diff showing the needed changes. - -### Adding new social media information - -To add new social media information, there are a few places you might need to modify. Currently, the template supports icons from [Academicons](https://jpswalsh.github.io/academicons/), [Font Awesome](https://fontawesome.com/), and [Tabler Icons](https://tabler.io/icons). For an example PR, check [Add HAL id to socials](https://github.com/alshedivat/al-folio/pull/3206/files). Note that the information in all these files are alphabetically sorted. - -- \_data/socials.yml - your social media information -- \_includes/metadata.liquid - add social media information to site metadata -- \_includes/social.liquid - where the social media icon will be displayed -- \_scripts/search.liquid.js - make the social media information appear in search - -## GitHub Copilot Agents - -This repository includes two specialized GitHub Copilot agents to assist with development and documentation: - -### Customization Agent - -The **Customization Agent** (`.github/agents/customize.agent.md`) helps users customize their al-folio website. It: - -- Guides you through modifying configuration files, adding content, and customizing the theme -- Explains technical concepts in plain language for users without coding experience -- Applies changes directly to your repository files -- Provides step-by-step instructions for common customization tasks - -To use the customization agent, you need to have [GitHub Copilot](https://github.com/features/copilot) enabled in your repository. The agent can help with tasks like changing site information, updating your CV, adding publications, creating blog posts, customizing theme colors, and more. - -### Documentation Agent - -The **Documentation Agent** (`.github/agents/docs.agent.md`) maintains the project documentation. It: - -- Updates and maintains documentation files (`README.md`, `INSTALL.md`, `CUSTOMIZE.md`, `FAQ.md`, `CONTRIBUTING.md`) -- Keeps documentation in sync with code changes -- Writes clear, concise documentation for users without technical backgrounds -- Follows documentation standards and best practices - -The documentation agent is primarily intended for maintainers and contributors who are updating the project documentation. - -### Important: Verify Agent Output - -While these agents are designed to assist you, **they can make mistakes or produce incorrect information**. Always review and verify the output before applying it to your repository: - -- **Review code and configuration changes** โ€“ Check that suggested modifications are correct and fit your needs -- **Test changes locally** โ€“ Before pushing to GitHub, test the changes locally (using Docker or native setup) -- **Verify syntax** โ€“ Ensure any YAML, Markdown, or configuration files have correct syntax -- **Check documentation** โ€“ If the agent generates documentation, review it for accuracy and clarity -- **Don't blindly apply changes** โ€“ Understand what changes are being made and why -- **Run your site** โ€“ After applying changes, run your site locally and verify everything works as expected - -**Example:** If an agent suggests a BibTeX entry or configuration change, verify that the syntax is correct and matches the existing style in your repository before committing. - -### How to Enable Agents - -GitHub Copilot agents are available to users with GitHub Copilot subscriptions. To use these agents: - -1. Ensure you have [GitHub Copilot](https://github.com/features/copilot) enabled for your account -2. Open your repository in an editor with GitHub Copilot support (such as VS Code with the GitHub Copilot extension) -3. The agents will be automatically available based on the configuration files in `.github/agents/`. For more information, see [Using custom agents in your IDE](https://docs.github.com/en/enterprise-cloud@latest/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents#using-custom-agents-in-your-ide). - -For more information about GitHub Copilot agents and how to use them, see the [GitHub Copilot documentation](https://docs.github.com/en/copilot). - -## Issues - -We use GitHub issues to track bugs and feature requests. -Before submitting an issue, please make sure: - -1. You have read [the FAQ section](FAQ.md) of the README and your question is NOT addressed there. -2. You have done your best to ensure that your issue is NOT a duplicate of one of [the previous issues](https://github.com/alshedivat/al-folio/issues). -3. Your issue is either a bug (unexpected/undesirable behavior) or a feature request. - If it is just a question, please ask it in the [Discussions](https://github.com/alshedivat/al-folio/discussions) forum. - -When submitting an issue, please make sure to use the appropriate template. - -## License - -By contributing to al-folio, you agree that your contributions will be licensed -under the LICENSE file in the root directory of the source tree. diff --git a/FAQ.md b/FAQ.md deleted file mode 100644 index beb3fd65..00000000 --- a/FAQ.md +++ /dev/null @@ -1,180 +0,0 @@ -# Frequently Asked Questions - -Here are some frequently asked questions. If you have a different question, please check if it was not already answered in the Q&A section of the [GitHub Discussions](https://github.com/alshedivat/al-folio/discussions/categories/q-a). If not, feel free to ask a new question there. - - - -- [Frequently Asked Questions](#frequently-asked-questions) - - [After I create a new repository from this template and setup the repo, I get a deployment error. Isn't the website supposed to correctly deploy automatically?](#after-i-create-a-new-repository-from-this-template-and-setup-the-repo-i-get-a-deployment-error-isnt-the-website-supposed-to-correctly-deploy-automatically) - - [I am using a custom domain (e.g., foo.com). My custom domain becomes blank in the repository settings after each deployment. How do I fix that?](#i-am-using-a-custom-domain-eg-foocom-my-custom-domain-becomes-blank-in-the-repository-settings-after-each-deployment-how-do-i-fix-that) - - [My webpage works locally. But after deploying, it fails to build and throws Unknown tag 'toc'. How do I fix that?](#my-webpage-works-locally-but-after-deploying-it-fails-to-build-and-throws-unknown-tag-toc-how-do-i-fix-that) - - [My webpage works locally. But after deploying, it is not displayed correctly (CSS and JS are not loaded properly). How do I fix that?](#my-webpage-works-locally-but-after-deploying-it-is-not-displayed-correctly-css-and-js-are-not-loaded-properly-how-do-i-fix-that) - - [Atom feed doesn't work. Why?](#atom-feed-doesnt-work-why) - - [My site doesn't work when I enable related_blog_posts. Why?](#my-site-doesnt-work-when-i-enable-related_blog_posts-why) - - [When trying to deploy, it's asking for github login credentials, which github disabled password authentication and it exits with an error. How to fix?](#when-trying-to-deploy-its-asking-for-github-login-credentials-which-github-disabled-password-authentication-and-it-exits-with-an-error-how-to-fix) - - [When I manually run the Lighthouse Badger workflow, it fails with Error: Input required and not supplied: token. How do I fix that?](#when-i-manually-run-the-lighthouse-badger-workflow-it-fails-with-error-input-required-and-not-supplied-token-how-do-i-fix-that) - - [My code runs fine locally, but when I create a commit and submit it, it fails with prettier code formatter workflow run failed for main branch. How do I fix that?](#my-code-runs-fine-locally-but-when-i-create-a-commit-and-submit-it-it-fails-with-prettier-code-formatter-workflow-run-failed-for-main-branch-how-do-i-fix-that) - - [After I update my site with some new content, even a small change, the GitHub action throws an error or displays a warning. What happened?](#after-i-update-my-site-with-some-new-content-even-a-small-change-the-github-action-throws-an-error-or-displays-a-warning-what-happened) - - [I am trying to deploy my site, but it fails with Could not find gem 'jekyll-diagrams' in locally installed gems. How do I fix that?](#i-am-trying-to-deploy-my-site-but-it-fails-with-could-not-find-gem-jekyll-diagrams-in-locally-installed-gems-how-do-i-fix-that) - - [How can I update Academicons version on the template](#how-can-i-update-academicons-version-on-the-template) - - [How can I update Font Awesome version on the template](#how-can-i-update-font-awesome-version-on-the-template) - - [How can I update Tabler Icons version on the template](#how-can-i-update-tabler-icons-version-on-the-template) - - [What do all these GitHub actions/workflows mean?](#what-do-all-these-github-actionsworkflows-mean) - - [How can I use Google Search Console ID on the template?](#how-can-i-use-google-search-console-id-on-the-template) - - [What are Code Wiki and DeepWiki?](#what-are-code-wiki-and-deepwiki) - - [When to use these tools](#when-to-use-these-tools) - - [What they do](#what-they-do) - - [Limitations](#limitations) - - [Access these tools](#access-these-tools) - - - -## After I create a new repository from this template and setup the repo, I get a deployment error. Isn't the website supposed to correctly deploy automatically? - -Yes, if you are using release `v0.3.5` or later, the website will automatically and correctly re-deploy right after your first commit. Please make some changes (e.g., change your website info in `_config.yml`), commit, and push. Make sure to follow [deployment instructions](https://github.com/alshedivat/al-folio#deployment). (Relevant issue: [209](https://github.com/alshedivat/al-folio/issues/209#issuecomment-798849211).) - -## I am using a custom domain (e.g., `foo.com`). My custom domain becomes blank in the repository settings after each deployment. How do I fix that? - -You need to add `CNAME` file to the `main` or `source` branch of your repository. The file should contain your custom domain name. (Relevant issue: [130](https://github.com/alshedivat/al-folio/issues/130).) - -## My webpage works locally. But after deploying, it fails to build and throws `Unknown tag 'toc'`. How do I fix that? - -Make sure you followed through the [deployment instructions](#deployment) in the previous section. You should have set the deployment branch to `gh-pages`. (Related issue: [1438](https://github.com/alshedivat/al-folio/issues/1438).) - -## My webpage works locally. But after deploying, it is not displayed correctly (CSS and JS are not loaded properly). How do I fix that? - -If the website does not load the theme, the layout looks weird, and all links are broken, being the main page displayed this way: - - - -make sure to correctly specify the `url` and `baseurl` paths in `_config.yml`. Set `url` to `https://.github.io` or to `https://` if you are using a custom domain. If you are deploying a personal or organization website, leave `baseurl` **empty** (do **NOT** delete it). If you are deploying a project page, set `baseurl: //`. If all previous steps were done correctly, all is missing is for your browser to fetch again the site stylesheet. For this, you can: - -- press [Shift + F5 on Chromium-based](https://support.google.com/chrome/answer/157179#zippy=%2Cwebpage-shortcuts) or [Ctrl + F5 on Firefox-based](https://support.mozilla.org/en-US/kb/keyboard-shortcuts-perform-firefox-tasks-quickly) browsers to reload the page ignoring cached content -- clean your browser history -- simply try it in a private session, here's how to do it in [Chrome](https://support.google.com/chrome/answer/95464) and [Firefox](https://support.mozilla.org/en-US/kb/private-browsing-use-firefox-without-history) - -## Atom feed doesn't work. Why? - -Make sure to correctly specify the `url` and `baseurl` paths in `_config.yml`. RSS Feed plugin works with these correctly set up fields: `title`, `url`, `description` and `author`. Make sure to fill them in an appropriate way and try again. - -## My site doesn't work when I enable `related_blog_posts`. Why? - -This is probably due to the [classifier reborn](https://github.com/jekyll/classifier-reborn) plugin, which is used to calculate related posts. If the error states `Liquid Exception: Zero vectors can not be normalized...` or `sqrt': Numerical argument is out of domain - "sqrt"`, it means that it could not calculate related posts for a specific post. This is usually caused by [empty or minimal blog posts](https://github.com/jekyll/classifier-reborn/issues/64) without meaningful words (i.e. only [stop words](https://en.wikipedia.org/wiki/Stop_words)) or even [specific characters](https://github.com/jekyll/classifier-reborn/issues/194) you used in your posts. Also, the calculus for similar posts are made for every `post`, which means every page that uses `layout: post`, including the announcements. To change this behavior, simply add `related_posts: false` to the front matter of the page you don't want to display related posts on. Another solution is to disable the lsi (latent semantic indexing) entirely by setting the `lsi` flag to `false` in `_config.yml`. Related issue: [#1828](https://github.com/alshedivat/al-folio/issues/1828). - -## When trying to deploy, it's asking for github login credentials, which github disabled password authentication and it exits with an error. How to fix? - -Open .git/config file using your preferred editor. Change the `https` portion of the `url` variable to `ssh`. Try deploying again. - -## When I manually run the Lighthouse Badger workflow, it fails with `Error: Input required and not supplied: token`. How do I fix that? - -You need to [create a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) and [add it as a secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-encrypted-secrets-for-a-repository) named `LIGHTHOUSE_BADGER_TOKEN` to your repository. For more information, check [lighthouse-badger documentation](https://github.com/MyActionWay/lighthouse-badger-workflows#lighthouse-badger-easyyml) on how to do this. - -## My code runs fine locally, but when I create a commit and submit it, it fails with `prettier code formatter workflow run failed for main branch`. How do I fix that? - -We implemented support for [Prettier code formatting](https://prettier.io/) in [#2048](https://github.com/alshedivat/al-folio/pull/2048). It basically ensures that your code is [well formatted](https://prettier.io/docs/en/). If you want to ensure your code is compliant with `Prettier`, you have a few options: - -- if you are running locally with `Docker` and using [development containers](https://github.com/alshedivat/al-folio/blob/main/INSTALL.md#local-setup-with-development-containers), `Prettier` is already included -- if you don't use `Docker`, it is simple to integrate it with your preferred IDE using an [extension](https://prettier.io/docs/en/editors) -- if you want to run it manually, you can follow the first 2 steps in [this tutorial](https://george-gca.github.io/blog/2023/slidev_for_non_web_devs/) (`Installing node version manager (nvm)` and `Installing Node (latest version)`), then, install it using `npm install prettier` inside the project directory, or install it globally on your computer using `npm install -g prettier`. To run `Prettier` on your current directory use `npx prettier . --write`. - -You can also disable it for your repo. For this, just delete the file [.github/workflows/prettier.yml](https://github.com/alshedivat/al-folio/blob/main/.github/workflows/prettier.yml). - -## After I update my site with some new content, even a small change, the GitHub action throws an error or displays a warning. What happened? - -Probably your GitHub workflow is throwing an error like this: - -```bash -/opt/hostedtoolcache/Ruby/3.0.2/x64/lib/ruby/gems/3.0.0/gems/bundler-2.5.5/lib/bundler/runtime.rb:304:in `check_for_activated_spec!': You have already activated uri 0.10.1, but your Gemfile requires uri 0.13.0. Since uri is a default gem, you can either remove your dependency on it or try updating to a newer version of bundler that supports uri as a default gem. (Gem::LoadError) -``` - -or maybe displaying a warning like one of these: - -``` -Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: actions/checkout@v3. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/. -Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: actions/checkout@v2, actions/cache@v2. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/. -The following actions uses node12 which is deprecated and will be forced to run on node16: actions/checkout@v2, actions/cache@v2. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/ -The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/ -``` - -If that's the case, you are using deprecated libraries/commands. This happens because you are using a very old version of al-folio. To fix this it is recommended [upgrading your code to the latest version](INSTALL.md#upgrading-from-a-previous-version) of the template. You will probably need to do some manual merging. If you find it easier, you could create a copy of your repository, do a fresh installation from the template and reapply all your changes. For this I would recommend a tool like [meld](https://meldmerge.org/) or [winmerge](https://winmerge.org/) to check the differences between directories/files. - -Note that libraries tend to be deprecated and support for them dropped as they are no longer maintained, and keep using them involves security breaches. Also, some of these deprecations are enforced, for example, by GitHub itself, so there's so much we can do. We have also added tons of new functionality, as well as tidying things up and improving the overall speed and structure, so you could also benefit from these improvements. - -## I am trying to deploy my site, but it fails with `Could not find gem 'jekyll-diagrams' in locally installed gems`. How do I fix that? - -`jekyll-diagrams` support was dropped in [#1992](https://github.com/alshedivat/al-folio/pull/1992) in favor of using `mermaid.js` directly. Simply [update your code](INSTALL.md#upgrading-from-a-previous-version) to get the latest changes. - -## How can I update Academicons version on the template - -To update the Academicons version, you need to download the latest release from the [Academicons website](https://jpswalsh.github.io/academicons/). After downloading, extract the zip file and copy the files `academicons.ttf` and `academicons.woff` from the `fonts/` directory to `assets/fonts/` and the file `academicons.min.css` from the `css/` directory to `assets/css/`. - -## How can I update Font Awesome version on the template - -To update the Font Awesome version, you need to download the latest release "for the web" from the [Font Awesome website](https://fontawesome.com/download). After downloading, extract the zip file and copy the `scss/` directory content to `_sass/font-awesome/` and the `webfonts/` content to `assets/webfonts/`. - -## How can I update Tabler Icons version on the template - -To update the Tabler Icons version, you need to download the latest release from the [Tabler Icons website](https://tabler.io/icons). After downloading, extract the zip file and copy the files `tabler-icons-filled.scss`, `tabler-icons-outline.scss`, and `tabler-icons.scss` from the `webfont/` directory to `_sass/tabler-icons/`, and all the files from `webfont/fonts/` to `assets/fonts/`. - -## What do all these GitHub actions/workflows mean? - -GitHub actions are a way to automate tasks in the repository. They are defined in `.github/workflows/` directory. Each file in this directory is a workflow. Workflows are made up of one or more jobs, and each job runs on a virtual machine hosted by GitHub. You can see the status of the workflows in the `Actions` tab of your repository. For more information, check the [GitHub Actions documentation](https://docs.github.com/en/actions). - -Currently we have the following workflows: - -- `axe.yml`: does some accessibility testing in your site. It uses the [axe cli](https://github.com/dequelabs/axe-core-npm/tree/develop/packages/cli) tool with a chrome driver to render the webpage and allow the analysis. Must be run manually, since fixing some of the issues is not straightforward -- `broken-links-site.yml`: checks for broken links in your built website with the [lychee-action](https://github.com/lycheeverse/lychee-action) -- `broken-links.yml`: checks for broken links in your repository with the [lychee-action](https://github.com/lycheeverse/lychee-action) -- `deploy-docker-tag.yml`: adds some metadata to the docker image and pushes it to Docker Hub -- `deploy-image.yml`: deploys a new docker image with the latest changes to Docker Hub -- `deploy.yml`: deploys the website to GitHub Pages -- `docker-slim.yml`: deploys a smaller version of the docker image to Docker Hub with the [docker-slim-action](https://github.com/kitabisa/docker-slim-action) -- `lighthouse-badger.yml`: runs a [lighthouse](https://github.com/GoogleChrome/lighthouse) test for your site with the [lighthouse-badger-action](https://github.com/MyActionWay/lighthouse-badger-action), saving the results in the repository for easy inspecting, as can be seen [here](https://github.com/alshedivat/al-folio?tab=readme-ov-file#lighthouse-pagespeed-insights). For more information on how to enable this workflow, check our [FAQ question about it](https://github.com/alshedivat/al-folio/blob/main/FAQ.md#when-i-manually-run-the-lighthouse-badger-workflow-it-fails-with-error-input-required-and-not-supplied-token-how-do-i-fix-that) -- `prettier-comment-on-pr.yml`: not working. For now, this action is disabled. It was supposed to run prettier on the PRs and comment on them with the changes needed. For more information, check [issue 2115](https://github.com/alshedivat/al-folio/issues/2115) -- `prettier.yml`: runs [prettier](https://prettier.io/) on the code to ensure it is well formatted. For more information, check our [FAQ question about it](https://github.com/alshedivat/al-folio/blob/main/FAQ.md#my-code-runs-fine-locally-but-when-i-create-a-commit-and-submit-it-it-fails-with-prettier-code-formatter-workflow-run-failed-for-main-branch-how-do-i-fix-that) - -## How can I use Google Search Console ID on the template? - -In the configuration file `_config.yml` the tag `google-site-verification` should be updated to use this functionality. Here is how you can proceed, - -- Generate your HTML tag by following [https://support.google.com/webmasters/answer/9008080?hl=en#meta_tag_verification&zippy=%2Chtml-tag](https://support.google.com/webmasters/answer/9008080?hl=en#meta_tag_verification&zippy=%2Chtml-tag) with URL prefix option. -- In the verify ownership option choose HTML tag and copy the tag contents which should look like ``. -- The string against `content` is the Google Search Console ID that can be used in the template. e.g. `google-site-verification: GoogleSearchConsoleID`. Now set the property `enable_google_verification: true`. - -It looks like the Domain type property in the Google Search Console to verify the ownership of all URLs across all subdomains with GitHub Pages does not work. - -## What are Code Wiki and DeepWiki? - -**Code Wiki** and **DeepWiki** are AI-powered tools that help you understand GitHub repositories through interactive documentation. They should be treated as supplementary resources when you cannot find the information you need in the official project documentation. - -### When to use these tools - -**Use Code Wiki and DeepWiki only after**: - -- You have reviewed the relevant documentation files in this repository (`README.md`, `INSTALL.md`, `CUSTOMIZE.md`, `FAQ.md`, or `CONTRIBUTING.md`) -- You have checked the [GitHub Discussions Q&A section](https://github.com/alshedivat/al-folio/discussions/categories/q-a) for similar questions -- You have searched existing [GitHub Issues](https://github.com/alshedivat/al-folio/issues) - -### What they do - -**Code Wiki** (powered by Google Gemini) generates interactive documentation from your repository code. It allows you to: - -- Browse your repository's structure and architecture -- Search for specific functions or modules -- Understand how different parts of the codebase work together -- Get diagrams and visual representations of your code architecture - -**DeepWiki** provides an AI-powered interface to ask questions about a repository, similar to having an engineer available 24/7. It allows you to: - -- Ask natural language questions about the codebase -- Get instant answers about how specific features work -- Search for code patterns and implementations - -### Limitations - -These tools are generated automatically from our code and may not always reflect the most current documentation standards or best practices specific to this project. They should not replace official documentation but rather complement it when you need deeper technical insights. - -### Access these tools - -- **Code Wiki**: [Code Wiki for al-folio](https://codewiki.google/github.com/alshedivat/al-folio) -- **DeepWiki**: [DeepWiki for al-folio](https://deepwiki.com/alshedivat/al-folio) diff --git a/Gemfile b/Gemfile index c62123b1..e7f6c5cc 100644 --- a/Gemfile +++ b/Gemfile @@ -31,13 +31,34 @@ end # Gems for development or external data fetching (outside :jekyll_plugins) group :other_plugins do gem 'css_parser' - gem 'feedjira' - gem 'httparty' - gem 'base64' # Ruby 4.0 compat - gem 'logger' # Ruby 4.0 compat gem 'observer' # used by jekyll-scholar gem 'ostruct' # used by jekyll-twitter-plugin # gem 'terser' # used by jekyll-terser # gem 'unicode_utils' -- should be already installed by jekyll # gem 'webrick' -- should be already installed by jekyll end + +# Gems for al-folio plugins +group :al_folio_plugins do + gem 'al_folio_core', '= 1.0.15' + gem 'al_icons', '= 1.0.0' + gem 'al_folio_cv', '= 1.0.2' + gem 'al_folio_distill', '= 1.0.3' + gem 'al_folio_upgrade', '= 1.0.3' + gem 'al_folio_bootstrap_compat', '= 1.0.0' + gem 'al_cookie', '= 1.0.1' + + gem 'al_analytics', '= 1.0.2' + gem 'al_citations', '= 1.0.1' + gem 'al_ext_posts', '= 1.0.3' + gem 'al_img_tools', '= 1.0.3' + gem 'al_search', '= 1.0.3' + gem 'al_charts', '= 1.0.1' + gem 'al_math', '= 1.0.2' + gem 'al_comments', '= 1.0.0' + gem 'al_newsletter', '= 1.0.0' + + gem 'al_email_protect', '= 1.0.1' + gem 'al_marimo', '= 1.0.0' + gem 'al_rtl', '= 1.0.0' +end diff --git a/INSTALL.md b/INSTALL.md deleted file mode 100644 index 14b3b0b6..00000000 --- a/INSTALL.md +++ /dev/null @@ -1,283 +0,0 @@ -# Installing and Deploying - - - -- [Installing and Deploying](#installing-and-deploying) - - [Recommended Approach](#recommended-approach) - - [Local setup on Windows](#local-setup-on-windows) - - [Local setup using Docker (Recommended)](#local-setup-using-docker-recommended) - - [Build your own docker image](#build-your-own-docker-image) - - [Have Bugs on Docker Image?](#have-bugs-on-docker-image) - - [Local Setup with Development Containers](#local-setup-with-development-containers) - - [Local Setup (Legacy, no longer supported)](#local-setup-legacy-no-longer-supported) - - [Deployment](#deployment) - - [For personal and organization webpages](#for-personal-and-organization-webpages) - - [For project pages](#for-project-pages) - - [Enabling automatic deployment](#enabling-automatic-deployment) - - [Manual deployment to GitHub Pages](#manual-deployment-to-github-pages) - - [Deploy on Netlify](https://www.netlify.com/) - - [Deployment to another hosting server (non GitHub Pages)](#deployment-to-another-hosting-server-non-github-pages) - - [Deployment to a separate repository (advanced users only)](#deployment-to-a-separate-repository-advanced-users-only) - - [Maintaining Dependencies](#maintaining-dependencies) - - [Updating the bundler itself](#updating-the-bundler-itself) - - [Updating all dependencies](#updating-all-dependencies) - - [Upgrading from a previous version](#upgrading-from-a-previous-version) - - - -## Recommended Approach - -The recommended approach for using **al-folio** is to first create your own site using the template with as few changes as possible, and only when it is up and running customize it however you like. This way it is easier to pinpoint what causes a potential issue in case of a bug. The minimum steps required to create your own site are ([video tutorial here](assets/video/tutorial_al_folio.mp4)): - -1. Create a new repository using this template. For this, click on [Use this template -> Create a new repository](https://github.com/new?template_name=al-folio&template_owner=alshedivat) above the file list. If you plan to upload your site to `.github.io`, note that the name of your repository :warning: **MUST BE** :warning: `.github.io` or `.github.io`, as stated in the [GitHub pages docs](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites). -2. In this new repository, go to [Settings -> Actions -> General -> Workflow permissions](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-default-github_token-permissions) and give `Read and write permissions` to GitHub Actions. -3. Open file `_config.yml`, set `url` to `https://.github.io` and leave `baseurl` **empty** (do NOT delete it), as `baseurl:`. -4. Wait until the GitHub action with subtitle `Deploy site` finishes (check your repository **Actions** tab), which takes ~4 min. Now, in addition to the `main` branch, your repository has a newly built `gh-pages` branch. -5. Finally, in the repository page go to `Settings -> Pages -> Build and deployment`, make sure that `Source` is set to `Deploy from a branch` and set the branch to `gh-pages` (NOT to main). -6. Wait until the GitHub action `pages-build-deployment` finishes (check your repository **Actions** tab), which takes ~45s, then simply navigate to `https://.github.io` in your browser. At this point you should see a copy of the theme's [demo website](https://alshedivat.github.io/al-folio/). - After everything is set up, you can download the repository to your machine and start customizing it. To do so, run the following commands: - -```bash -$ git clone git@github.com:/.git -``` - -Starting version [v0.3.5](https://github.com/alshedivat/al-folio/releases/tag/v0.3.5), **al-folio** will automatically re-deploy your webpage each time you push new changes to your repository! :sparkles: - -## Local setup on Windows - -If you are using Windows, it is **highly recommended** to use [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install), which is a compatibility layer for running Linux on top of Windows. You can follow [these instructions](https://ubuntu.com/tutorials/install-ubuntu-on-wsl2-on-windows-11-with-gui-support) to install WSL and Ubuntu on your machine. You only need to go up to the step 4 of the tutorial (you don't have to enable the optional `systemd` nor the graphical applications), and then you can follow the instructions below to install docker. You can install docker natively on Windows as well, but it has been having some issues as can be seen in [#1540](https://github.com/alshedivat/al-folio/issues/1540), [#2007](https://github.com/alshedivat/al-folio/issues/2007). - -## Local setup using Docker (Recommended) - -Using Docker to install Jekyll and Ruby dependencies is the easiest way. - -You need to take the following steps to get `al-folio` up and running on your local machine: - -- First, install [docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/). -- Finally, run the following command that will pull the latest pre-built image from DockerHub and will run your website. - -```bash -$ docker compose pull -$ docker compose up -``` - -Note that when you run it for the first time, it will download a docker image of size 400MB or so. To see the template running, open your browser and go to `http://localhost:8080`. You should see a copy of the theme's demo website. - -Now, feel free to customize the theme however you like (don't forget to change the name!). Also, your changes should be automatically rendered in real-time (or maybe after a few seconds). - -> Beta: You can also use the slimmed docker image with a size below 100MBs and exact same functionality. Just use `docker compose -f docker-compose-slim.yml up` - -### Build your own docker image - -> Note: this approach is only necessary if you would like to build an older or very custom version of al-folio. - -Build and run a new docker image using: - -```bash -$ docker compose up --build -``` - -> If you want to update jekyll, install new ruby packages, etc., all you have to do is build the image again using `--force-recreate` argument at the end of the previous command! It will download Ruby and Jekyll and install all Ruby packages again from scratch. - -If you want to use a specific docker version, you can do so by changing `latest` tag to `your_version` in `docker-compose.yaml`. For example, you might have created your website on `v0.10.0` and you want to stick with that. - -### Have Bugs on Docker Image? - -Sometimes, there might be some bugs in the current docker image. It might be version mismatch or anything. If you want to debug and easily solve the problem for yourself you can do the following steps: - -``` -docker compose up -d -docker compose logs -``` - -Then you can see the bug! You can enter the container via this command: - -``` -docker compose exec -it jekyll /bin/bash -``` - -Then you can run the script: - -``` -./bin/entry_point.sh -``` - -You might see problems for package dependecy or something which is not available. You can fix it now by using - -``` -bundle install -./bin/entry_point.sh -``` - -Most likely, this will solve the problem but it shouldn't really happen. So, please open a bug report for us. - -## Local Setup with Development Containers - -`al-folio` supports [Development Containers](https://containers.dev/supporting). -For example, when you open the repository with Visual Studio Code (VSCode), it prompts you to install the necessary extension and automatically install everything necessary. - -## Local Setup (Legacy, no longer supported) - -For a hands-on walkthrough of running al-folio locally without using Docker, check out [this cool blog post](https://george-gca.github.io/blog/2022/running-local-al-folio/) by one of the community members! - -Assuming you have [Ruby](https://www.ruby-lang.org/en/downloads/) and [Bundler](https://bundler.io/) installed on your system (_hint: for ease of managing ruby gems, consider using [rbenv](https://github.com/rbenv/rbenv)_), and also [Python](https://www.python.org/) and [pip](https://pypi.org/project/pip/) (_hint: for ease of managing python packages, consider using a virtual environment, like [venv](https://docs.python.org/pt-br/3/library/venv.html) or [conda](https://docs.conda.io/en/latest/)_). - -```bash -$ bundle install -# assuming pip is your Python package manager -$ pip install jupyter -$ bundle exec jekyll serve -``` - -To see the template running, open your browser and go to `http://localhost:4000`. You should see a copy of the theme's [demo website](https://alshedivat.github.io/al-folio/). Now, feel free to customize the theme however you like. After you are done, remember to **commit** your final changes. - -## Deployment - -Deploying your website to [GitHub Pages](https://pages.github.com/) is the most popular option. -Starting version [v0.3.5](https://github.com/alshedivat/al-folio/releases/tag/v0.3.5), **al-folio** will automatically re-deploy your webpage each time you push new changes to your repository **main branch**! :sparkles: - -### For personal and organization webpages - -1. The name of your repository **MUST BE** `.github.io` or `.github.io`. -2. In `_config.yml`, set `url` to `https://.github.io` and leave `baseurl` empty. -3. Set up automatic deployment of your webpage (see instructions below). -4. Make changes to your main branch, commit, and push! -5. After deployment, the webpage will become available at `.github.io`. - -### For project pages - -1. In `_config.yml`, set `url` to `https://.github.io` and `baseurl` to `//`. -2. Set up automatic deployment of your webpage (see instructions below). -3. Make changes to your main branch, commit, and push! -4. After deployment, the webpage will become available at `.github.io//`. - -### Enabling automatic deployment - -1. Click on **Actions** tab and **Enable GitHub Actions**; do not worry about creating any workflows as everything has already been set for you. -2. Go to `Settings -> Actions -> General -> Workflow permissions`, and give `Read and write permissions` to GitHub Actions -3. Make any other changes to your webpage, commit, and push to your main branch. This will automatically trigger the **Deploy** action. -4. Wait for a few minutes and let the action complete. You can see the progress in the **Actions** tab. If completed successfully, in addition to the `main` branch, your repository should now have a newly built `gh-pages` branch. **Do NOT touch this branch!** -5. Finally, in the **Settings** of your repository, in the Pages section, set the branch to `gh-pages` (**NOT** to `main`). For more details, see [Configuring a publishing source for your GitHub Pages site](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source). - -If you keep your site on another branch, open `.github/workflows/deploy.yml` **on the branch you keep your website on** and change `on->push->branches` and `on->pull\_request->branches` to the branch you keep your website on. This will trigger the action on pulls/pushes on that branch. The action will then deploy the website on the branch it was triggered from. - -### Manual deployment to GitHub Pages - -If you need to manually re-deploy your website to GitHub pages, go to Actions, click "Deploy" in the left sidebar, then "Run workflow." - -### Deploy on [Netlify](https://www.netlify.com/) - -1. [Use this template -> Create a new repository](https://github.com/new?template_name=al-folio&template_owner=alshedivat). -2. Netlify: **Add new site** -> **Import an existing project** -> **GitHub** and give Netlify access to the repository you just created. -3. Netlify: In the deploy settings - - - Set **Branch to deploy** to `main` - - **Base directory** is empty - - Set **Build command** to `sed -i "s/^\(baseurl: \).*$/baseurl:/" _config.yml && bundle exec jekyll build` - - Set **Publish directory** to `_site` - -4. Netlify: Add the following two **environment variables** - - - | Key | Value | - | -------------- | -------------------------------------------------------------------------------------- | - | `JEKYLL_ENV` | `production` | - | `RUBY_VERSION` | set to the Ruby version found in `.github/workflows/deploy.yml` (for example, `3.3.5`) | - -5. Netlify: Click **Deploy** and wait for the site to be published. If you want to use your own domain name, follow the steps in [this documentation](https://docs.netlify.com/domains-https/custom-domains/). - -### Deployment to another hosting server (non GitHub Pages) - -If you decide to not use GitHub Pages and host your page elsewhere, simply run: - -```bash -$ bundle exec jekyll build -``` - -which will (re-)generate the static webpage in the `_site/` folder. -Then simply copy the contents of the `_site/` directory to your hosting server. - -If you also want to remove unused css classes from your file, run: - -```bash -$ purgecss -c purgecss.config.js -``` - -which will replace the css files in the `_site/assets/css/` folder with the purged css files. - -**Note:** Make sure to correctly set the `url` and `baseurl` fields in `_config.yml` before building the webpage. If you are deploying your webpage to `your-domain.com/your-project/`, you must set `url: your-domain.com` and `baseurl: /your-project/`. If you are deploying directly to `your-domain.com`, leave `baseurl` blank, **do not delete it**. - -### Deployment to a separate repository (advanced users only) - -**Note:** Do not try using this method unless you know what you are doing (make sure you are familiar with [publishing sources](https://help.github.com/en/github/working-with-github-pages/about-github-pages#publishing-sources-for-github-pages-sites)). This approach allows to have the website's source code in one repository and the deployment version in a different repository. - -Let's assume that your website's publishing source is a `publishing-source` subdirectory of a git-versioned repository cloned under `$HOME/repo/`. -For a user site this could well be something like `$HOME/.github.io`. - -Firstly, from the deployment repo dir, checkout the git branch hosting your publishing source. - -Then from the website sources dir (commonly your al-folio fork's clone): - -```bash -$ bundle exec jekyll build --destination $HOME/repo/publishing-source -``` - -This will instruct jekyll to deploy the website under `$HOME/repo/publishing-source`. - -**Note:** Jekyll will clean `$HOME/repo/publishing-source` before building! - -The quote below is taken directly from the [jekyll configuration docs](https://jekyllrb.com/docs/configuration/options/): - -> Destination folders are cleaned on site builds -> -> The contents of `` are automatically cleaned, by default, when the site is built. Files or folders that are not created by your site will be removed. Some files could be retained by specifying them within the `` configuration directive. -> -> Do not use an important location for ``; instead, use it as a staging area and copy files from there to your web server. - -If `$HOME/repo/publishing-source` contains files that you want jekyll to leave untouched, specify them under `keep_files` in `_config.yml`. -In its default configuration, al-folio will copy the top-level `README.md` to the publishing source. If you want to change this behavior, add `README.md` under `exclude` in `_config.yml`. - -**Note:** Do _not_ run `jekyll clean` on your publishing source repo as this will result in the entire directory getting deleted, irrespective of the content of `keep_files` in `_config.yml`. - -## Maintaining Dependencies - -**al-folio** uses **Bundler** (a Ruby dependency manager) to keep track of all the Ruby packages (called "gems") needed to run Jekyll and its plugins. Over time, these packages may receive updates that include bug fixes, security patches, and new features. - -### Updating the bundler itself - -The bundler tool itself should be kept up to date. To update bundler to the latest version, run: - -```bash -$ bundle update --bundler -``` - -### Updating all dependencies - -To update all Ruby gems to their latest compatible versions (as specified in your `Gemfile`), run: - -```bash -$ bundle update --all -``` - -After updating dependencies, test your site locally to ensure everything still works correctly: - -- If using Docker: `docker compose up` -- If using local setup: `bundle exec jekyll serve` - -> **Note:** Dependency updates may occasionally introduce breaking changes. If your site fails after updating, check the [FAQ](FAQ.md) for troubleshooting, or revert to the previous version with `bundle lock --add-platform ruby` and `git checkout Gemfile.lock`. - -## Upgrading from a previous version - -If you installed **al-folio** as described above, you can manually update your code by following the steps below: - -```bash -# Assuming the current directory is -$ git remote add upstream https://github.com/alshedivat/al-folio.git -$ git fetch upstream -$ git rebase v0.16.3 -``` - -If you have extensively customized a previous version, it might be trickier to upgrade. -You can still follow the steps above, but `git rebase` may result in merge conflicts that must be resolved. -See [git rebase manual](https://help.github.com/en/github/using-git/about-git-rebase) and how to [resolve conflicts](https://help.github.com/en/github/using-git/resolving-merge-conflicts-after-a-git-rebase) for more information. -If rebasing is too complicated, we recommend re-installing the new version of the theme from scratch and port over your content and changes from the previous version manually. You can use tools like [meld](https://meldmerge.org/) -or [winmerge](https://winmerge.org/) to help in this process. diff --git a/_config.yml b/_config.yml index a4f5694b..5138abb4 100644 --- a/_config.yml +++ b/_config.yml @@ -6,7 +6,6 @@ title: blank # the website title (if blank, full name will be used instead) first_name: Ted middle_name: last_name: Apel -email: tedapel@gmail.com contact_note: # description: > # the ">" symbol means to ignore newlines until "footer_text:" Ted Apel is a sound artist whose work explores how sound becomes intelligible through material systems, speculative sonic processes, and distributed listening. @@ -14,6 +13,7 @@ footer_text: # keywords: Ted Apel, soundart # add your own keywords or leave empty lang: en # the language of your site (for example: en, fr, cn, ru, etc.) icon: vud-32.png # the emoji used as the favicon (alternatively, provide image name in /assets/img/) +apple_touch_icon: vud-180.png # image name in /assets/img/ (or a rooted path / absolute URL) used for iOS home-screen bookmarks; needs a real 180x180 PNG, since Safari ignores the emoji favicon above. Left empty, iOS falls back to a screenshot of the page. url: https://vud.org # the base hostname & protocol for your site baseurl: # the subpath of your site, e.g. /blog/. Leave blank for root @@ -26,10 +26,21 @@ back_to_top: true # set to false to disable the back to top button # ----------------------------------------------------------------------------- # repo color theme -repo_theme_light: default # https://github.com/anuraghazra/github-readme-stats/blob/master/themes/README.md -repo_theme_dark: dark # https://github.com/anuraghazra/github-readme-stats/blob/master/themes/README.md +repo_theme_light: default # https://github.com/stats-organization/github-stats-extended/blob/master/packages/core/src/themes/README.md +repo_theme_dark: dark # https://github.com/stats-organization/github-stats-extended/blob/master/packages/core/src/themes/README.md +# Off by default: addresses are then split at build time so the HTML contains no +# `user@host` and no `mailto:` for harvesters to scrape, and clicking one copies +# it to the clipboard instead of opening a mail client. +# See "Protecting email addresses from scrapers" in docs/CUSTOMIZE.md. +protect_email: false + +# Off by default: the free public github-profile-trophy instance is disabled +# (its Vercel deployment answers HTTP 402 / DEPLOYMENT_DISABLED), so every trophy +# image 404s. The project itself is still open source and free โ€” self-host it and +# point external_services.github_profile_trophy_url at your instance, then set +# enabled: true. See docs/CUSTOMIZE.md. repo_trophies: - enabled: true + enabled: false theme_light: flat # https://github.com/ryo-ma/github-profile-trophy theme_dark: gitdimmed # https://github.com/ryo-ma/github-profile-trophy @@ -37,9 +48,39 @@ repo_trophies: # To use a different instance or service for displaying GitHub stats and trophies, # update these URLs. These are used in the repository templates. external_services: - github_readme_stats_url: https://github-readme-stats.vercel.app + github_readme_stats_url: https://github-stats-extended.vercel.app github_profile_trophy_url: https://github-profile-trophy.vercel.app +# ----------------------------------------------------------------------------- +# al-folio API (v1.x) +# ----------------------------------------------------------------------------- + +al_folio: + api_version: 1 + style_engine: tailwind + tailwind: + version: 4.1.18 + preflight: false + css_entry: assets/tailwind/app.css + distill: + engine: distillpub-template + source: al-org-dev/distill-template#al-folio + allow_remote_loader: false + features: + cv: + enabled: true + distill: + enabled: true + compat: + bootstrap: + enabled: false + support_window: v1.0-v1.2 + deprecates_in: v1.3 + removed_in: v2.0 + upgrade: + channel: stable + auto_apply_safe_fixes: false + # ----------------------------------------------------------------------------- # RSS Feed # ----------------------------------------------------------------------------- @@ -60,8 +101,6 @@ bib_search: true # Dimensions max_width: 800px -# TODO: add layout settings (single page vs. multi-page) - # ----------------------------------------------------------------------------- # Open Graph & Schema.org # ----------------------------------------------------------------------------- @@ -75,12 +114,15 @@ og_image: assets/img/TedApel.jpg # The site-wide (default for all links) Open Gr # Analytics and search engine verification # ----------------------------------------------------------------------------- -# For Google Analytics, see https://support.google.com/analytics/answer/10447272?hl=en&ref_topic=14088998&sjid=5129943941510317771-SA#zippy=%2Cgoogle-sites -# and follow the instructions for Google Sites. You will need to create a Google Analytics property and copy the Google tag ID. -google_analytics: # your Google Analytics measurement ID (format: G-XXXXXXXXXX) -cronitor_analytics: # cronitor RUM analytics site ID (format: XXXXXXXXX) -pirsch_analytics: # your Pirsch analytics site ID (length 32 characters) -openpanel_analytics: # your Openpanel analytics client ID (format: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) +analytics: + # For Google Analytics, see https://support.google.com/analytics/answer/10447272?hl=en&ref_topic=14088998&sjid=5129943941510317771-SA#zippy=%2Cgoogle-sites + # and follow the instructions for Google Sites. You will need to create a Google Analytics property and copy the Google tag ID. + google: # your Google Analytics measurement ID (format: G-XXXXXXXXXX) + cronitor: # cronitor RUM analytics site ID (format: XXXXXXXXX) + pirsch: # your Pirsch analytics site ID (length 32 characters) + openpanel: # your Openpanel analytics client ID (format: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) + cloudflare: # your Cloudflare Web Analytics beacon token (32 hex characters) +enable_simple_analytics: false # Simple Analytics identifies a site by its domain, so it has no ID to set above # For Google Search Console, see https://support.google.com/webmasters/answer/9008080?hl=en#meta_tag_verification&zippy=%2Chtml-tag google_site_verification: # your google-site-verification ID (Google Search Console) @@ -143,6 +185,8 @@ newsletter: # ----------------------------------------------------------------------------- collections: + books: + output: true news: defaults: layout: post @@ -151,26 +195,10 @@ collections: projects: output: true permalink: /projects/:path/ - eurorack: - output: true - permalink: /eurorack/:path/ - infrasound: - output: true - permalink: /infrasound/:path/ teachings: output: true permalink: /teaching/:path/ -announcements: - enabled: true - scrollable: false - limit: 5 - -latest_posts: - enabled: false - scrollable: true - limit: 3 - # ----------------------------------------------------------------------------- # Jekyll settings # ----------------------------------------------------------------------------- @@ -189,31 +217,38 @@ kramdown: start_line: 1 # Includes & excludes -include: ["_pages", "_scripts"] +include: ["_pages"] exclude: + - AGENTS.md + - al-folio-upgrade-report.md - bin/ - - CONTRIBUTING.md - - CUSTOMIZE.md + - CLAUDE.md - Dockerfile - docker-compose.yml - docker-compose-slim.yml - - FAQ.md + - docs/ - Gemfile - Gemfile.lock - - INSTALL.md - LICENSE - lighthouse_results/ - package.json - package-lock.json - _pages/about_einstein.md + - context/ - purgecss.config.js - README.md - readme_preview/ + - requirements.txt + - gems/ + - migrations/ - vendor keep_files: - CNAME - .nojekyll +# Use al_folio_core as the theme runtime; local files can still override theme files. +theme: al_folio_core + # Plug-ins plugins: - jekyll-3rd-party-libraries @@ -237,6 +272,27 @@ plugins: - jekyll-twitter-plugin - jemoji + # al-folio plugins + - al_folio_core + - al_icons + - al_folio_cv + - al_folio_distill + - al_folio_upgrade + - al_folio_bootstrap_compat + - al_cookie + - al_analytics + - al_citations + - al_ext_posts + - al_img_tools + - al_search + - al_charts + - al_math + - al_comments + - al_newsletter + - al_email_protect + - al_marimo + - al_rtl + # Sitemap settings defaults: - scope: @@ -253,7 +309,13 @@ sass: jekyll-minifier: compress_javascript: false # set to false since we are using terser as the js minifier - exclude: ["robots.txt", "assets/js/search/*.js"] + # CSS is already minified upstream (Tailwind build ships tailwind.css; main.scss is compiled + # with sass `style: compressed`). Re-minifying via cssminify2 mangles Tailwind v4 spacing + # tokens inside calc(), turning `var(--spacing)` into the invalid `var( - - spacing)` and + # breaking every spacing/positioning utility (e.g. .fixed-top -> broken navbar). Disable it. + compress_css: false + # JS minification is delegated to jekyll-terser (compress_javascript above is false). + exclude: ["robots.txt"] # ----------------------------------------------------------------------------- # Terser @@ -274,9 +336,11 @@ jekyll-archives: year: "/blog/:year/" tags: "/blog/:type/:name/" categories: "/blog/:type/:name/" + books: + enabled: [year, tags, categories] # enables year, tag and category archives (remove if you need to disable one of them). -display_tags: ["formatting", "images", "links", "math", "code"] # these tags will be displayed on the front page of your blog -display_categories: ["blockquotes"] # these categories will be displayed on the front page of your blog +display_tags: ["formatting", "images", "links", "math", "code", "blockquotes"] # these tags will be displayed on the front page of your blog +display_categories: ["external-services"] # these categories will be displayed on the front page of your blog # ----------------------------------------------------------------------------- # Jekyll Scholar @@ -399,12 +463,9 @@ lazy_loading_images: true # enables lazy loading of images (recommended) # Optional Features # ----------------------------------------------------------------------------- -enable_google_analytics: false # enables google analytics -enable_cronitor_analytics: false # enables cronitor RUM analytics -enable_pirsch_analytics: false # enables Pirsch analytics (https://pirsch.io/) -enable_openpanel_analytics: false # enables Openpanel analytics (https://openpanel.dev/) enable_google_verification: false # enables google site verification enable_bing_verification: false # enables bing site verification +enable_cookie_consent: false # enables GDPR-compliant cookie consent dialog (https://github.com/orestbida/cookieconsent) enable_masonry: true # enables automatic project cards arrangement enable_math: true # enables math typesetting (uses MathJax) enable_tooltips: false # enables automatic tooltip links generated for each section titles on pages and posts @@ -432,6 +493,18 @@ third_party_libraries: css: "https://cdn.jsdelivr.net/npm/bootstrap-table@{{version}}/dist/bootstrap-table.min.css" js: "https://cdn.jsdelivr.net/npm/bootstrap-table@{{version}}/dist/bootstrap-table.min.js" version: "1.22.4" + fontawesome: + integrity: + css: "sha256-MVopmdyC2tYTiJ8wlktf0uh0v4NgT+vNdyVFepi7Q0c=" + url: + css: "https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@{{version}}/css/all.min.css" + version: "7.2.0" + academicons: + integrity: + css: "sha256-SzrCOBJbGVFMahewkgjwnApaV2+av1DwMAA+/QGLyZw=" + url: + css: "https://cdn.jsdelivr.net/npm/academicons@{{version}}/css/academicons.min.css" + version: "1.9.5" chartjs: integrity: js: "sha256-0q+JdOlScWOHcunpUk21uab1jW7C1deBQARHtKMcaB4=" @@ -479,18 +552,8 @@ third_party_libraries: integrity: js: "sha256-htrLFfZJ6v5udOG+3kNLINIKh2gvoKqwEhHYfTTMICc=" url: - js: https://cdn.jsdelivr.net/npm/imagesloaded@{{version}}/imagesloaded.pkgd.min.js + js: "https://cdn.jsdelivr.net/npm/imagesloaded@{{version}}/imagesloaded.pkgd.min.js" version: "5.0.0" - img-comparison-slider: - integrity: - css: "sha256-3qTIuuUWIFnnU3LpQMjqiXc0p09rvd0dmj+WkpQXSR8=" - js: "sha256-EXHg3x1K4oIWdyohPeKX2ZS++Wxt/FRPH7Nl01nat1o=" - map: "sha256-3wfqS2WU5kGA/ePcgFzJXl5oSN1QsgZI4/edprTgX8w=" - url: - css: "https://cdn.jsdelivr.net/npm/img-comparison-slider@{{version}}/dist/styles.min.css" - js: "https://cdn.jsdelivr.net/npm/img-comparison-slider@{{version}}/dist/index.min.js" - map: "https://cdn.jsdelivr.net/npm/img-comparison-slider@{{version}}/dist/index.js.map" - version: "8.0.6" jquery: integrity: js: "sha256-/xUj+3OJU5yExlq6GSYGSHk7tPXikynS7ogEvDej/m4=" @@ -510,23 +573,6 @@ third_party_libraries: js: "https://cdn.jsdelivr.net/npm/leaflet@{{version}}/dist/leaflet.min.js" js_map: "https://cdn.jsdelivr.net/npm/leaflet@{{version}}/dist/leaflet.js.map" version: "1.9.4" - lightbox2: - integrity: - css: "sha256-uypRbsAiJcFInM/ndyI/JHpzNe6DtUNXaWEUWEPfMGo=" - js: "sha256-A6jI5V9s1JznkWwsBaRK8kSeXLgIqQfxfnvdDOZEURY=" - url: - css: "https://cdn.jsdelivr.net/npm/lightbox2@{{version}}/dist/css/lightbox.min.css" - js: "https://cdn.jsdelivr.net/npm/lightbox2@{{version}}/dist/js/lightbox.min.js" - version: "2.11.5" - mathjax: - integrity: - js: "sha256-MASABpB4tYktI2Oitl4t+78w/lyA+D7b/s9GEP0JOGI=" - local: - fonts: "output/chtml/fonts/woff-v2/" - url: - fonts: "https://cdn.jsdelivr.net/npm/mathjax@{{version}}/es5/output/chtml/fonts/woff-v2/" - js: "https://cdn.jsdelivr.net/npm/mathjax@{{version}}/es5/tex-mml-chtml.js" - version: "3.2.2" masonry: integrity: js: "sha256-Nn1q/fx0H7SNLZMQ5Hw5JLaTRZp0yILA/FRexe19VdI=" @@ -545,41 +591,43 @@ third_party_libraries: js: "https://cdn.jsdelivr.net/npm/mdbootstrap@{{version}}/js/mdb.min.js" js_map: "https://cdn.jsdelivr.net/npm/mdbootstrap@{{version}}/js/mdb.min.js.map" version: "4.20.0" - medium_zoom: - integrity: - js: "sha256-ZgMyDAIYDYGxbcpJcfUnYwNevG/xi9OHKaR/8GK+jWc=" - url: - js: "https://cdn.jsdelivr.net/npm/medium-zoom@{{version}}/dist/medium-zoom.min.js" - version: "1.1.0" mermaid: integrity: js: "sha256-TtLOdUA8mstPoO6sGvHIGx2ceXrrX4KgIItO06XOn8A=" url: js: "https://cdn.jsdelivr.net/npm/mermaid@{{version}}/dist/mermaid.min.js" version: "10.7.0" - photoswipe: + mathjax: integrity: - js: "sha256-VCBpdxvrNNxGHNuTdNqK9kPFkev2XY7DYzHdmgaB69Q=" + js: "sha256-MASABpB4tYktI2Oitl4t+78w/lyA+D7b/s9GEP0JOGI=" + local: + fonts: "output/chtml/fonts/woff-v2/" url: - css: "https://cdn.jsdelivr.net/npm/photoswipe@{{version}}/dist/photoswipe.min.css" - js: "https://cdn.jsdelivr.net/npm/photoswipe@{{version}}/dist/photoswipe.esm.min.js" - version: "5.4.4" - photoswipe-lightbox: + fonts: "https://cdn.jsdelivr.net/npm/mathjax@{{version}}/es5/output/chtml/fonts/woff-v2/" + js: "https://cdn.jsdelivr.net/npm/mathjax@{{version}}/es5/tex-mml-chtml.js" + version: "3.2.2" + tikzjax: integrity: - js: "sha256-uCw4VgT5DMdwgtjhvU9e98nT2mLZXcw/8WkaTrDd3RI=" + css: "sha256-p+CQrhSq3dnLHELDcVBFDf4whOor3w8gzLuc/pwRLyQ=" + js: "sha256-7SCmUR11IG4MkSoeLUq0pombv7oeV7yZuu7Z82e4Uy4=" url: - js: "https://cdn.jsdelivr.net/npm/photoswipe@{{version}}/dist/photoswipe-lightbox.esm.min.js" - version: "5.4.4" + css: "https://cdn.jsdelivr.net/npm/@planktimerr/tikzjax@{{version}}/dist/fonts.css" + js: "https://cdn.jsdelivr.net/npm/@planktimerr/tikzjax@{{version}}/dist/tikzjax.js" + version: "1.0.8" + tocbot: + integrity: + css: "sha256-zTN0r+0OKaIv2xqeNNIYxNk0pWJ6+IqPGc1iDgVzWF0=" + js: "sha256-lo/r+jQ81wWrxdIiiiEEd538z4+dTJTt+leOuAS7GCw=" + url: + css: "https://cdn.jsdelivr.net/npm/tocbot@{{version}}/dist/tocbot.css" + js: "https://cdn.jsdelivr.net/npm/tocbot@{{version}}/dist/tocbot.min.js" + version: "4.36.4" plotly: integrity: js: "sha256-oy6Be7Eh6eiQFs5M7oXuPxxm9qbJXEtTpfSI93dW16Q=" url: js: "https://cdn.jsdelivr.net/npm/plotly.js@{{version}}/dist/plotly.min.js" version: "3.0.1" - polyfill: - url: - js: "https://cdnjs.cloudflare.com/polyfill/v{{version}}/polyfill.min.js?features=es6" - version: "3" pseudocode: integrity: css: "sha256-VwMV//xgBPDyRFVSOshhRhzJRDyBmIACniLPpeXNUdc=" @@ -588,29 +636,26 @@ third_party_libraries: css: "https://cdn.jsdelivr.net/npm/pseudocode@{{version}}/build/pseudocode.min.css" js: "https://cdn.jsdelivr.net/npm/pseudocode@{{version}}/build/pseudocode.min.js" version: "2.4.1" - spotlight: + scholar-icons: integrity: - css: "sha256-Dsvkx8BU8ntk9Iv+4sCkgHRynYSQQFP6gJfBN5STFLY=" + css: "sha256-VY3hHVj/hNX3fYG6wtbA6TcKJQl7+FthzGSyIB64klY=" url: - css: "https://cdn.jsdelivr.net/npm/spotlight.js@{{version}}/dist/css/spotlight.min.css" - js: "https://cdn.jsdelivr.net/npm/spotlight.js@{{version}}/dist/spotlight.bundle.min.js" - version: "0.7.8" - swiper: + css: "https://cdn.jsdelivr.net/npm/scholar-icons@{{version}}/css/scholar-icons.css" + version: "1.0.3" + vanilla-back-to-top: integrity: - css: "sha256-yUoNxsvX+Vo8Trj3lZ/Y5ZBf8HlBFsB6Xwm7rH75/9E=" - js: "sha256-BPrwikijIybg9OQC5SYFFqhBjERYOn97tCureFgYH1E=" - map: "sha256-lbF5CsospW93otqvWOIbbhj80CjazrZXvamD7nC7TBI=" + js: "sha256-uMJJ3EoTyfRBoTbR+lrfu1uRQ87RZG8AR3cVNuQVeFg=" url: - css: "https://cdn.jsdelivr.net/npm/swiper@{{version}}/swiper-bundle.min.css" - js: "https://cdn.jsdelivr.net/npm/swiper@{{version}}/swiper-element-bundle.min.js" - map: "https://cdn.jsdelivr.net/npm/swiper@{{version}}/swiper-element-bundle.min.js.map" - version: "11.0.5" - swiper-map: + js: "https://cdn.jsdelivr.net/npm/vanilla-back-to-top@{{version}}/dist/vanilla-back-to-top.min.js" + version: "7.2.1" + vanilla-cookieconsent: integrity: - js: "sha256-hlZaH8ySXX97bZaetnrtYlKuhx3oEXFz/s2IXchu6vk=" + css: "sha256-ygRrixsQlBByBZiOcJamh7JByO9fP+/l5UPtKNJmRsE=" + js: "sha256-vG4vLmOB/AJbJ6awr7Wg4fxonG+fxAp4cIrbIFTvRXU=" url: - js: "https://cdn.jsdelivr.net/npm/swiper@11.1.0/swiper-element-bundle.min.js.map" - version: "11.0.5" + css: "https://cdn.jsdelivr.net/npm/vanilla-cookieconsent@{{version}}/dist/cookieconsent.css" + js: "https://cdn.jsdelivr.net/npm/vanilla-cookieconsent@{{version}}/dist/cookieconsent.umd.js" + version: "3.1.0" vega: integrity: js: "sha256-Yot/cfgMMMpFwkp/5azR20Tfkt24PFqQ6IQS+80HIZs=" @@ -635,14 +680,6 @@ third_party_libraries: js: "https://cdn.jsdelivr.net/npm/vega-lite@{{version}}/build/vega-lite.min.js" js_map: "https://cdn.jsdelivr.net/npm/vega-lite@{{version}}/build/vega-lite.min.js.map" version: "5.16.3" - venobox: - integrity: - css: "sha256-ohJEB0/WsBOdBD+gQO/MGfyJSbTUI8OOLbQGdkxD6Cg=" - js: "sha256-LsGXHsHMMmTcz3KqTaWvLv6ome+7pRiic2LPnzTfiSo=" - url: - css: "https://cdn.jsdelivr.net/npm/venobox@{{version}}/dist/venobox.min.css" - js: "https://cdn.jsdelivr.net/npm/venobox@{{version}}/dist/venobox.min.js" - version: "2.1.8" # ----------------------------------------------------------------------------- # Get external JSON data diff --git a/_includes/audio.liquid b/_includes/audio.liquid deleted file mode 100644 index 338e2124..00000000 --- a/_includes/audio.liquid +++ /dev/null @@ -1,30 +0,0 @@ -
-
diff --git a/_includes/bib_search.liquid b/_includes/bib_search.liquid deleted file mode 100644 index c0ab526c..00000000 --- a/_includes/bib_search.liquid +++ /dev/null @@ -1,4 +0,0 @@ -{% if site.bib_search %} - - -{% endif %} diff --git a/_includes/calendar.liquid b/_includes/calendar.liquid deleted file mode 100644 index fab192dd..00000000 --- a/_includes/calendar.liquid +++ /dev/null @@ -1,25 +0,0 @@ -{% if include.calendar_id %} -
-

Upcoming Events

- - - - -
-{% endif %} diff --git a/_includes/citation.liquid b/_includes/citation.liquid deleted file mode 100644 index 35bd9e37..00000000 --- a/_includes/citation.liquid +++ /dev/null @@ -1,26 +0,0 @@ -
-
-
- -If you found this useful, please cite this as: - -{% capture citation_quote -%} -> {{ site.last_name }}, {{ site.first_name }}{% if site.middle_name %} {{ site.middle_name }}{% endif %} ({{ page.date | date: "%b %Y" }}). {{ page.title }}. {% if site.title != 'blank' %}{{ site.title }}. {% endif %}{{ site.url }}. -{%- endcapture %} -{{ citation_quote | markdownify }} - -

or as a BibTeX entry:

- -{% capture citation_code -%} -```bibtex -@article{ {{- site.last_name | downcase }}{{ page.date | date: "%Y" }}{{ page.title | slugify }}, - title = { {{- page.title -}} }, - author = { {{- site.last_name }}, {{ site.first_name }}{% if site.middle_name %} {{ site.middle_name }}{% endif -%}}, - {%- if site.title != 'blank' %}journal = { {{- site.title -}} },{% endif %} - year = { {{- page.date | date: "%Y" -}} }, - month = { {{- page.date | date: "%b" -}} }, - url = { {{- site.url }}{{ page.url -}} } -} -``` -{%- endcapture %} -{{ citation_code | markdownify }} diff --git a/_includes/course_schedule.liquid b/_includes/course_schedule.liquid deleted file mode 100644 index 363387b6..00000000 --- a/_includes/course_schedule.liquid +++ /dev/null @@ -1,71 +0,0 @@ -{% assign course = site.teachings | where: 'course_id', include.course_id | first %} - -{% if course %} -
-

{{ course.title }}

- - {% if course.description %} -
- {{ course.description | markdownify }} -
- {% endif %} - - {% if course.instructor %} -

Instructor: {{ course.instructor }}

- {% endif %} - - {% if course.term %} -

Term: {{ course.term }}

- {% endif %} - - {% if course.schedule %} - - - - - - - - - - - {% for entry in course.schedule %} - - - - - - - {% endfor %} - -
WeekDateTopicMaterials
{{ entry.week }}{{ entry.date }} - {% if entry.topic %} - {{ entry.topic }} - {% endif %} - {% if entry.description %} -
{{ entry.description | markdownify }}
- {% endif %} -
- {% if entry.materials %} -
    - {% for material in entry.materials %} -
  • - {% if material.url %} - {% if material.url contains '://' %} - {{ material.name }} - {% else %} - {{ material.name }} - {% endif %} - {% else %} - {{ material.name }} - {% endif %} -
  • - {% endfor %} -
- {% endif %} -
- {% else %} -

No schedule available for this course.

- {% endif %} -
-{% endif %} diff --git a/_includes/cv/list.liquid b/_includes/cv/list.liquid deleted file mode 100644 index 1cc2598e..00000000 --- a/_includes/cv/list.liquid +++ /dev/null @@ -1,5 +0,0 @@ -
    - {% for content in entry.contents %} -
  • {{ content }}
  • - {% endfor %} -
diff --git a/_includes/cv/list_groups.liquid b/_includes/cv/list_groups.liquid deleted file mode 100644 index 1ca90e4b..00000000 --- a/_includes/cv/list_groups.liquid +++ /dev/null @@ -1,51 +0,0 @@ -
- {% for content in entry.contents %} -
- - - - {% if content.icon %} - - {% else %} - - {% endif %} - - {% assign i = 1 %} - {% for item in content.items %} - {% assign i = i | plus: 1 %} - {% endfor %} - - - {% for item in content.items %} - - - - {% if item.level %} - - {% endif %} - {% if item.school %} - - {% else %} - - {% endif %} - {% if item.link %} - - {% endif %} - - {% endfor %} - -
{{ content.category }}
- {{ item.name }} - {{ item.level }}{{ item.school }} - {% endif %} - {% if item.time %} -
- {{ item.time }} -
-
- {% endfor %} -
diff --git a/_includes/cv/map.liquid b/_includes/cv/map.liquid deleted file mode 100644 index aee3419f..00000000 --- a/_includes/cv/map.liquid +++ /dev/null @@ -1,29 +0,0 @@ - - {% for content in entry.contents %} - - - {% if content.value %} - - {% endif %} - {% if content.links %} - - {% endif %} - - {% endfor %} -
- {{ content.name }} - {{ content.value }} -
- {% for item in content.links %} - {% if item.link %} - - {% endif %} - {% endfor %} -
-
diff --git a/_includes/cv/nested_list.liquid b/_includes/cv/nested_list.liquid deleted file mode 100644 index 72200dec..00000000 --- a/_includes/cv/nested_list.liquid +++ /dev/null @@ -1,16 +0,0 @@ -
    - {% for content in entry.contents %} -
  • -
    {{ content.title }}
    - {% if content.items %} -
      - {% for subitem in content.items %} -
    • - {{ subitem }} -
    • - {% endfor %} -
    - {% endif %} -
  • - {% endfor %} -
diff --git a/_includes/cv/time_table.liquid b/_includes/cv/time_table.liquid deleted file mode 100644 index 11962df8..00000000 --- a/_includes/cv/time_table.liquid +++ /dev/null @@ -1,118 +0,0 @@ -
    - {% for content in entry.contents %} -
  • -
    - {% if content.year %} -
    - - - - - - {% if content.location %} - - - - {% endif %} - -
    - - {{- content.year -}} - -
    -

    - - {{ content.location }} -

    -
    -
    - {% endif %} -
    - {% if content.title %} -
    {{ content.title }}
    - {% endif %} - {% if content.department or content.institution %} - - - {% if content.institution %} - - - - - {% endif %} - {% if content.department %} - - - - - {% endif %} - -
    - - {{ content.institution }}
    - - {{ content.department }}
    - {% endif %} - {% if content.maindescription %} -
    {{ content.maindescription }}
    - {% endif %} - {% if content.description %} -
      - {% for item in content.description %} -
    • - {% if item.contents %} - {{ item.title }} -
        - {% for subitem in item.contents %} -
      • - {{ subitem }} -
      • - {% endfor %} -
      - {% else %} - {{ item }} - {% endif %} -
    • - {% endfor %} -
    - {% endif %} - {% if content.items %} -
      - {% for item in content.items %} -
    • - {% if item.contents %} - {{ item.title }} -
        - {% for subitem in item.contents %} -
      • - {{ subitem }} -
      • - {% endfor %} -
      - {% else %} - {{ item }} - {% endif %} -
    • - {% endfor %} -
    - {% endif %} - {% if content.linkitems %} - - {% endif %} -
    -
    -
  • - {% endfor %} -
diff --git a/_includes/disqus.liquid b/_includes/disqus.liquid deleted file mode 100644 index 6979a4ec..00000000 --- a/_includes/disqus.liquid +++ /dev/null @@ -1,13 +0,0 @@ -
- - -
diff --git a/_includes/distill_scripts.liquid b/_includes/distill_scripts.liquid deleted file mode 100644 index 8a8aa1f3..00000000 --- a/_includes/distill_scripts.liquid +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - - - - - -{% if page.mermaid and page.mermaid.enabled %} - - - {% if page.mermaid.zoomable %} - - {% endif %} - -{% endif %} - -{% if page.code_diff %} - - - - -{% endif %} - -{% if page.map %} - - - -{% endif %} - -{% if page.chart and page.chart.chartjs %} - - - -{% endif %} - -{% if page.chart and page.chart.echarts %} - - - {% if site.enable_darkmode %} - - {% endif %} - -{% endif %} - -{% if page.chart and page.chart.plotly %} - - - -{% endif %} - -{% if page.chart and page.chart.vega_lite %} - - - - - -{% endif %} - -{% if page.tikzjax %} - - -{% endif %} - -{% if page.typograms %} - - -{% endif %} - -{% if site.enable_tooltips %} - - -{% endif %} - -{% if site.enable_medium_zoom %} - - - -{% endif %} - -{% if page.toc and page.toc.sidebar %} - - -{% endif %} - -{% if page.pretty_table %} - - - -{% endif %} - - - - - - - - - - - -{% if site.enable_math %} - - - - - -{% endif %} - -{% if site.enable_google_analytics %} - - - - -{% endif %} - -{% if site.enable_cronitor_analytics %} - - - -{% endif %} -{% if site.enable_pirsch_analytics %} - -{% endif %} -{% if site.enable_openpanel_analytics %} - - -{% endif %} - -{% if site.enable_progressbar %} - - -{% endif %} - -{% if page.images %} - - {% if page.images.compare %} - - {% endif %} - {% if page.images.lightbox2 %} - - {% endif %} - {% if page.images.photoswipe %} - - {% endif %} - {% if page.images.slider %} - - {% endif %} - {% if page.images.spotlight %} - - {% endif %} - {% if page.images.venobox %} - - - {% endif %} -{% endif %} - -{% if page.tabs %} - - -{% endif %} - -{% if site.back_to_top %} - - - -{% endif %} - -{% if site.search_enabled %} - - - - - - -{% endif %} diff --git a/_includes/figure.liquid b/_includes/figure.liquid deleted file mode 100644 index 5bf96bdf..00000000 --- a/_includes/figure.liquid +++ /dev/null @@ -1,86 +0,0 @@ -{% assign img_path = include.path | remove: '.jpg' | remove: '.jpeg' | remove: '.png' | remove: '.tiff' | remove: '.gif' %} -{% assign parts = include.path | split: '.' %} -{% assign ext = parts.last %} - -
- - - - {% if site.imagemagick.enabled %} - {% unless include.avoid_scaling %} - - {% endunless %} - {% endif %} - {{ include.alt }} - - - {% if include.caption %} -
{{ include.caption }}
- {% endif %} -
diff --git a/_includes/footer.liquid b/_includes/footer.liquid deleted file mode 100644 index f028dfe0..00000000 --- a/_includes/footer.liquid +++ /dev/null @@ -1,30 +0,0 @@ -{% capture footer_contents %} - © Copyright {{ site.time | date: '%Y' }} - {{ site.first_name }} - {{ site.middle_name }} - {{ site.last_name }}. {{ site.footer_text }} - {% if site.impressum_path %} - Impressum. - {% endif %} - {% if site.last_updated %} - Last updated: {{ 'now' | date: '%B %d, %Y' }}. - {% endif %} -{% endcapture %} - -{% if site.footer_fixed %} -
-
- {{ footer_contents }} -
-
-{% else %} -
- {% if site.newsletter.enabled %} - {% include newsletter.liquid %} - {% endif %} - -
- {{ footer_contents }} -
-
-{% endif %} diff --git a/_includes/giscus.liquid b/_includes/giscus.liquid deleted file mode 100644 index f4e6f069..00000000 --- a/_includes/giscus.liquid +++ /dev/null @@ -1,25 +0,0 @@ -
- {% if page.layout == 'post' %} -
- {% endif %} - - {% if site.giscus.repo %} - - - {% else %} - {% capture giscus_warning %} -> ##### giscus comments misconfigured -> Please follow instructions at [http://giscus.app](http://giscus.app) and update your giscus configuration. -{: .block-danger } - {% endcapture %} - {{ giscus_warning | markdownify }} - {% endif %} -
diff --git a/_includes/head.liquid b/_includes/head.liquid deleted file mode 100644 index 718aad78..00000000 --- a/_includes/head.liquid +++ /dev/null @@ -1,190 +0,0 @@ - -{% include metadata.liquid %} - - - - - -{% if page.pretty_table %} - - -{% endif %} - - - - - - - - - -{% if page.toc and page.toc.sidebar %} - - -{% endif %} - - - -{% if page.pseudocode %} - - -{% endif %} - -{% if site.icon.size <= 4 %} - -{% elsif site.icon != blank %} - -{% endif %} - - - - -{% if site.enable_darkmode %} - - - - -{% endif %} - -{% if page.map %} - - -{% endif %} - -{% if page.code_diff %} - - - - -{% endif %} - -{% if page.images %} - {% if page.images.compare %} - - - {% endif %} - {% if page.images.lightbox2 %} - - - {% endif %} - {% if page.images.photoswipe %} - - - {% endif %} - {% if page.images.slider %} - - - {% endif %} - {% if page.images.spotlight %} - - - {% endif %} - {% if page.images.venobox %} - - - {% endif %} -{% endif %} - -{% if page.tikzjax %} - -{% endif %} diff --git a/_includes/header.liquid b/_includes/header.liquid index 1cace93f..95cb7b1a 100644 --- a/_includes/header.liquid +++ b/_includes/header.liquid @@ -29,10 +29,9 @@ {% endif %} -