Format & GitHub Workflow

Author: Tom-Notch

.github/copilot-instructions.md

@@ -55,7 +55,7 @@ This repo is an Astro 5 + MDX site with optional React "islands," Tailwind CSS v
 - Code blocks are styled by `astro-expressive-code`; don't manually theme them—follow the existing configuration in `astro.config.ts`.
 - To add a new interactive component:
   1. Create it under `src/components/` (Astro or React).
-  2. Import it in `src/paper.mdx`.
-  3. For React, add `client:*` (e.g., `client:idle`) at the usage site.
+  1. Import it in `src/paper.mdx`.
+  1. For React, add `client:*` (e.g., `client:idle`) at the usage site.
 
 If anything here seems off or incomplete (tests aren’t defined, additional pages, alt deploys), tell me what’s missing and I’ll refine these instructions.

.github/workflows/astro.yml

@@ -3,31 +3,25 @@
 # To get started with Astro see: https://docs.astro.build/en/getting-started/
 #
 name: Deploy Astro site to Pages
-
 on:
   # Runs on pushes targeting the default branch
   push:
-    branches: ["main"]
-
+    branches: ["website"]
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
-
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
   contents: read
   pages: write
   id-token: write
-
 # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
 # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
 concurrency:
   group: "pages"
   cancel-in-progress: false
-
 env:
   BUILD_PATH: "." # default value when not using subfolders
   # BUILD_PATH: subfolder
-
 jobs:
   build:
     name: Build
@@ -76,7 +70,6 @@ jobs:
         uses: actions/upload-pages-artifact@v3
         with:
           path: ${{ env.BUILD_PATH }}/dist
-
   deploy:
     environment:
       name: github-pages

.github/workflows/pre-commit.yml

@@ -0,0 +1,15 @@
+name: pre-commit
+on:
+  pull_request:
+  push:
+    branches:
+      - '*'
+      - '*/*'
+      - '**'
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - uses: pre-commit/action@v3.0.0

.pre-commit-config.yaml

@@ -0,0 +1,86 @@
+---
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+# Don't run pre-commit on files under any thirdparty/, third_party/, third-party/, etc. sub-folders
+# But will run on directories like third/.../../party/, etc.
+exclude: (?i)^(.*third[^/]*party/.*|.*\.trt)$
+
+repos:
+  - repo: https://github.com/sirosen/check-jsonschema # check-jsonschema is a github actions and workflows verifier.
+    rev: 0.37.1
+    hooks:
+      - id: check-github-actions
+      - id: check-github-workflows
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v4.0.0-alpha.8
+    hooks:
+        - id: prettier
+          types_or: [css, scss, json, javascript, html]
+          exclude: (?i)(.*main.*scss)$
+
+  - repo: https://github.com/google/yamlfmt
+    rev: v0.21.0
+    hooks:
+        - id: yamlfmt
+          exclude: (?i)(.pre-commit-config.yaml)$
+
+  - repo: https://github.com/jonasbb/pre-commit-latex-hooks
+    rev: v1.5.0
+    hooks:
+      - id: american-eg-ie
+      - id: cleveref-capitalization
+      - id: consistent-spelling
+        args:
+          [
+            "--emph=et al.",
+            "--emph=a priori",
+            "--emph=a posteriori",
+            '--regex=naive=\bna(i|\\"i)ve',
+          ]
+      - id: csquotes
+      - id: ensure-labels-for-sections
+        args:
+            [
+              # If present only check that there is a \label{} but not the value
+              "--ignore-label-content",
+            ]
+      - id: no-space-in-cite
+      - id: tilde-cite
+      - id: unique-labels
+        # args:
+        #     [
+        #       # If present only check for uniqueness within each file.
+        #       # Can be useful if a repository contains multiple main files.
+        #       "--individual",
+        #     ]
+      - id: cleveref-instead-of-autoref
+
+  - repo: https://github.com/cmhughes/latexindent.pl.git
+    rev: V4.0
+    hooks:
+      - id: latexindent
+
+  - repo: https://github.com/executablebooks/mdformat # mdformat is a markdown formatter.
+    rev: 1.0.0
+    hooks:
+      - id: mdformat
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks # pre-commit-hooks is a collection of additional pre-commit hooks.
+    rev: v6.0.0
+    hooks:
+      # - id: requirements-txt-fixer # fixes requirements.txt and requirements-dev.txt.
+      # - id: check-added-large-files # prevents giant files from being committed.
+      - id: check-case-conflict # checks for files that would conflict in case-insensitive filesystem.
+      - id: check-merge-conflict # checks for files that contain merge conflict strings.
+      - id: check-yaml # checks yaml files for parseable syntax.
+        args:
+          - --allow-multiple-documents
+          - --unsafe
+      # - id: check-executables-have-shebangs # ensures that (non-binary) executables have a shebang.
+      # - id: check-shebang-scripts-are-executable # ensures that (non-binary) files with a shebang are executable.
+      - id: end-of-file-fixer # ensures that a file is either empty, or ends with one newline.
+      - id: fix-byte-order-marker # removes utf-8 byte order marker.
+      - id: mixed-line-ending # replaces or checks mixed line ending.
+      - id: trailing-whitespace # trims trailing whitespace.

.prettierignore

@@ -1,3 +1,3 @@
 # As of 2025-10-18, Prettier only supports MDX v1.0.
 # See https://github.com/prettier/prettier/issues/12209 for updates.
-*.mdx
+*.mdx

README.md

@@ -31,15 +31,15 @@ This is a template to help you build a professional project page for your resear
 ## Usage
 
 1. Click ["Use this template"](https://github.com/new?template_name=academic-project-astro-template&template_owner=RomanHauksson) to make a copy of this repository in your GitHub account.
-2. Enable GitHub Pages for the repository. Click on the **Settings** tab, then go to **Pages** (under the **Code and automation** section). Using the dropdown, change **Source** from "Deploy from a branch" to "GitHub Actions".
+1. Enable GitHub Pages for the repository. Click on the **Settings** tab, then go to **Pages** (under the **Code and automation** section). Using the dropdown, change **Source** from "Deploy from a branch" to "GitHub Actions".
 
 At this point, whenever you push to the `main` branch, the GitHub Actions workflow in `.github/workflows/astro.yml` will automatically build a static website and deploy it to `https://<username>.github.io/<repository>/`. No other configuration is necessary!
 
 To edit the content, you _could_ simply edit [`./src/paper.mdx`](./src/paper.mdx) in your browser in the GitHub interface, without downloading or setting anything else up. But if you want to preview your changes faster, I recommend editing it locally:
 
 3. Clone the repository.
 
-4. [Install Node.js](https://nodejs.org/en/download/) if you haven't already. Make sure you're using version 24 or later, which you can check by running
+1. [Install Node.js](https://nodejs.org/en/download/) if you haven't already. Make sure you're using version 24 or later, which you can check by running
 
 ```bash
 node --version
@@ -67,7 +67,7 @@ While the development server is running, you can open `http://localhost:4321` in
 
 8. Edit the content in [`./src/paper.mdx`](./src/paper.mdx). Every time you save a file, the development server will automatically reload `http://localhost:4321` to display the updated version of the page.
 
-9. Push your changes to the GitHub repository to trigger a new deployment with your changes.
+1. Push your changes to the GitHub repository to trigger a new deployment with your changes.
 
 Alternatively, you can build the site locally, and copy the output to wherever you'd like to host the site. Running the following command will create a static website stored in `./dist/`.
 

bibliography.bib

@@ -6,4 +6,4 @@ @inproceedings{vaswani2017attention
   pages     = {5998--6008},
   year      = {2017},
   url       = {https://proceedings.neurips.cc/paper/2017/file/3f5ee243547dee91fbd053c1c4a845aa-Paper.pdf}
-}
+}

public/google78f44d7a1045c1da.html

@@ -1 +1 @@
-google-site-verification: google78f44d7a1045c1da.html
+google-site-verification: google78f44d7a1045c1da.html

src/paper.mdx

@@ -205,4 +205,4 @@ Displaying the BibTeX entry for your paper in a code block makes it easy to copy
 
 ## Bibliography
 
-[^ref]
+[^ref]