diff --git a/.github/agents/customize.agent.md b/.github/agents/customize.agent.md index 4a2c328..8703284 100644 --- a/.github/agents/customize.agent.md +++ b/.github/agents/customize.agent.md @@ -344,7 +344,6 @@ Always guide users to test changes locally before pushing to GitHub: 3. **Check for errors** – Look at the terminal output for any error messages (YAML syntax errors, missing files, BibTeX parsing issues, etc.). 4. **Verify visually** – Manually navigate through your site: - - Check that pages load without errors - Verify text displays correctly - Ensure images are visible @@ -352,7 +351,6 @@ Always guide users to test changes locally before pushing to GitHub: - Check that your changes appear as expected 5. **Test on different pages** – If you modified: - - `_config.yml` – Check the entire site (affects global settings) - Blog posts – Check the blog page and individual post - Publications – Check the publications page @@ -436,7 +434,6 @@ Help users avoid these frequent errors: ## Boundaries - ✅ **Always do:** - - Modify configuration files (`_config.yml`, `_data/*.yml`) - Create/edit content files (posts, pages, projects, news) - Update BibTeX bibliography @@ -446,7 +443,6 @@ Help users avoid these frequent errors: - Reference official documentation when helpful - ⚠️ **Ask first:** - - Major structural changes to the template - Removing core functionality or pages - Modifying GitHub Actions workflows @@ -498,21 +494,17 @@ Help users avoid these frequent errors: When users reference issues or discussions: 1. **Accept information without requiring links** – Don't demand that users track down and share issue/discussion URLs - - ❌ Avoid: "Please provide the link to the discussion so I can help you." - ✅ Do this: "Let me help based on what you've described. If you remember any details from the discussion, that would be helpful." 2. **Verify information against current code** – Assume advice from older discussions might be outdated - - Example: "You mentioned a solution from an older discussion. Let me check if that still applies with the current version..." - Be prepared to offer updated guidance if the codebase has changed 3. **Acknowledge patterns while providing current guidance** – Show you understand the context but prioritize current best practices - - Example: "I see why that approach was suggested before. With our current code, here's the recommended way to do this..." 4. **Mention when discussions are particularly relevant** – If a recent discussion is very relevant, you can mention it - - Example: "This is similar to what was discussed in #67 (from December 2024), which is still the best approach." 5. **Suggest sharing solutions** – If a user's question or your solution would help the community, encourage them to update or create discussions diff --git a/.github/agents/docs.agent.md b/.github/agents/docs.agent.md index b059e04..60a4a49 100644 --- a/.github/agents/docs.agent.md +++ b/.github/agents/docs.agent.md @@ -133,7 +133,6 @@ to process your files located in `_layouts/` and `_includes/`. ## Boundaries - ✅ **Always do:** - - Update documentation files (`*.md` in root directory) - Keep documentation in sync with actual code and configuration - Use existing documentation style and structure (or improve it with patterns from this agent) @@ -143,7 +142,6 @@ to process your files located in `_layouts/` and `_includes/`. - Preserve existing table of contents markers (`` and `` - ⚠️ **Ask first:** - - Major restructuring of documentation organization - Adding entirely new documentation files - Changing the documentation format or style guide diff --git a/CUSTOMIZE.md b/CUSTOMIZE.md index fd5eefc..a809c95 100644 --- a/CUSTOMIZE.md +++ b/CUSTOMIZE.md @@ -213,7 +213,6 @@ Understanding al-folio's technology stack will help you better customize and ext ### Backend - **Jekyll 4.x**: [Jekyll](https://jekyllrb.com/) is a static site generator written in Ruby that transforms your Markdown files and templates into a static website. Jekyll is used to: - - Convert Markdown files to HTML - Process Liquid templates - Manage collections (posts, projects, news, books, etc.) @@ -221,7 +220,6 @@ Understanding al-folio's technology stack will help you better customize and ext - Minify CSS and JavaScript - **Ruby Gems** (Jekyll plugins): The project uses several Ruby plugins to extend Jekyll's functionality: - - `jekyll-scholar`: Manages bibliography files (BibTeX) and generates publication pages with citations - `jekyll-archives-v2`: Creates archive pages for posts and collections organized by category, tag, or date - `jekyll-paginate-v2`: Handles pagination for blog posts and archives @@ -239,7 +237,6 @@ Understanding al-folio's technology stack will help you better customize and ext ### Build and Deployment - **GitHub Actions**: Automated workflows for building, testing, and deploying your site. Workflows are defined in `.github/workflows/`: - - **Deploy**: Automatically builds and deploys your site to GitHub Pages when you push changes to the main branch - **Link checking**: Validates that all links in your site are not broken - **Code formatting**: Ensures code follows the Prettier code style @@ -467,7 +464,6 @@ To update a library: 1. Change the `version` number 2. Obtain the new integrity hash for the updated library version and update the `integrity` field with the new hash. You can: - - Check if the CDN provider (e.g., jsDelivr, cdnjs, unpkg) provides the SRI hash for the file. Many CDN sites display the SRI hash alongside the file URL. - Generate the SRI hash yourself using a tool such as [SRI Hash Generator](https://www.srihash.org/) or by running the following command in your terminal: @@ -477,7 +473,6 @@ To update a library: Replace `[FILE_URL]` with the URL of the library file. Then, prefix the result with `sha384-` and use it in the `integrity` field. For detailed instructions on updating specific libraries, see the FAQ: - - [How can I update Academicons version](FAQ.md#how-can-i-update-academicons-version-on-the-template) - [How can I update Font Awesome version](FAQ.md#how-can-i-update-font-awesome-version-on-the-template) - [How can I update Tabler Icons version](FAQ.md#how-can-i-update-tabler-icons-version-on-the-template) @@ -660,7 +655,6 @@ GitHub restricts the default `GITHUB_TOKEN` from triggering other workflows when ### How to set up the PAT 1. **Create a Personal Access Token** - - Go to [GitHub Settings > Developer settings > Personal access tokens](https://github.com/settings/tokens). - Click "Generate new token" (classic or fine-grained). - Grant at least the following permissions: @@ -668,7 +662,6 @@ GitHub restricts the default `GITHUB_TOKEN` from triggering other workflows when - Save the token somewhere safe. 2. **Add the PAT as a repository secret** - - Go to your repository on GitHub. - Navigate to `Settings` > `Secrets and variables` > `Actions` > `New repository secret`. - Name the secret `PAT` (must match the name used in the workflow). diff --git a/INSTALL.md b/INSTALL.md index ef29779..1e34da2 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -167,14 +167,12 @@ If you need to manually re-deploy your website to GitHub pages, go to Actions, c 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` | diff --git a/_posts/2015-07-15-code.md b/_posts/2015-07-15-code.md index 5f669c0..4859938 100644 --- a/_posts/2015-07-15-code.md +++ b/_posts/2015-07-15-code.md @@ -43,7 +43,6 @@ For displaying code in a list item, you have to be aware of the indentation, as ````markdown 1. We can put fenced code blocks inside nested bullets, too. - 1. Like this: ```c @@ -56,7 +55,6 @@ For displaying code in a list item, you have to be aware of the indentation, as Which displays: 1. We can put fenced code blocks inside nested bullets, too. - 1. Like this: ```c diff --git a/assets/js/distillpub/transforms.v2.js b/assets/js/distillpub/transforms.v2.js index abbcc86..95ff112 100644 --- a/assets/js/distillpub/transforms.v2.js +++ b/assets/js/distillpub/transforms.v2.js @@ -436,7 +436,7 @@ } function createCommonjsModule(fn, module) { - return (module = { exports: {} }), fn(module, module.exports), module.exports; + return ((module = { exports: {} }), fn(module, module.exports), module.exports); } var bibtexParse = createCommonjsModule(function (module, exports) { diff --git a/package-lock.json b/package-lock.json index 4327cd9..67b3aeb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6,18 +6,18 @@ "": { "devDependencies": { "@shopify/prettier-plugin-liquid": "1.4.0", - "prettier": "3.1.1" + "prettier": "^3.1.1" } }, "node_modules/@shopify/liquid-html-parser": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/@shopify/liquid-html-parser/-/liquid-html-parser-2.2.0.tgz", - "integrity": "sha512-hD0XV+Re9BC3yMOshHCwU94LagW7LQTWPdtpU0IE/pMbco+ke7Hir1Ad7eloHAgzR+6iw4LzDEFuHFpKZWmGKw==", + "version": "2.9.0", + "resolved": "https://registry.npmjs.org/@shopify/liquid-html-parser/-/liquid-html-parser-2.9.0.tgz", + "integrity": "sha512-bkI4tLbU47YUxpgbMa9fgeJjFEMvRNEFL644Yk0ZKo5H1IRzU4pPyCQ6PkGvb0JJnt7OZ+RDGvb6ZLCnAR2Z/A==", "dev": true, "license": "MIT", "dependencies": { "line-column": "^1.0.2", - "ohm-js": "^16.3.0" + "ohm-js": "^17.0.0" } }, "node_modules/@shopify/prettier-plugin-liquid": { @@ -73,9 +73,9 @@ } }, "node_modules/ohm-js": { - "version": "16.6.0", - "resolved": "https://registry.npmjs.org/ohm-js/-/ohm-js-16.6.0.tgz", - "integrity": "sha512-X9P4koSGa7swgVQ0gt71UCYtkAQGOjciJPJAz74kDxWt8nXbH5HrDOQG6qBDH7SR40ktNv4x61BwpTDE9q4lRA==", + "version": "17.3.0", + "resolved": "https://registry.npmjs.org/ohm-js/-/ohm-js-17.3.0.tgz", + "integrity": "sha512-LySMdjweN1hKBMMV8lM44+1wiewkndDNNJxtgVAscs7y683MXCdQZLsIaw64/p8NuqYbKOWZoHIOA5DU/xchoA==", "dev": true, "license": "MIT", "engines": { @@ -83,9 +83,9 @@ } }, "node_modules/prettier": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.1.1.tgz", - "integrity": "sha512-22UbSzg8luF4UuZtzgiUOfcGM8s4tjBv6dJRT7j275NXsy2jb4aJa4NNveul5x4eqlF1wuhuR2RElK71RvmVaw==", + "version": "3.7.4", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.7.4.tgz", + "integrity": "sha512-v6UNi1+3hSlVvv8fSaoUbggEM5VErKmmpGA7Pl3HF8V6uKY7rvClBOJlH6yNwQtfTueNkGVpOv/mtWL9L4bgRA==", "dev": true, "license": "MIT", "bin": { diff --git a/package.json b/package.json index dc4c51a..b0ca4a7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "devDependencies": { - "@shopify/prettier-plugin-liquid": "1.4.0", - "prettier": "3.1.1" + "@shopify/prettier-plugin-liquid": "1.10.0", + "prettier": "^3.7.4" } }