The landing page for Ventris Tools, live at https://ventris-tools.github.io.
Ventris Tools is an open-source project for understanding EEG. Its first tool is Ventris, a web-based EEG decoding app.
This is plain HTML and CSS, with no build step and no dependencies.
python3 -m http.server 4174 --directory siteThen open http://localhost:4174. The Ventris card's link gives a 404 here, because /ventris/ is a separate site.
The site has no dependencies, but its checks do. They need Node 22.22 or 24.8 and up, and Google Chrome.
npm ci
npm run checkThis validates the HTML, then opens the pages in Chrome. It looks for console errors, including anything the Content Security Policy blocks, and for broken links and missing files. It also checks that every character is in the font subset, that both themes pass an accessibility scan, that phones get no sideways scrolling, and that the home page stays within its page weight budget and fits one desktop screen. It also fails if the images below are out of date.
npm run check:links checks every link on the live site, including the ones that leave it. GitHub Actions runs it every Monday. It is separate from npm run check, so another site being down can't block a deploy.
Every push to main runs the checks on GitHub Actions. If they pass, GitHub Pages publishes the site folder they tested. If they fail, the last good version stays live.
Everything in site/ is published, so keep anything that shouldn't be public out of it.
The app at /ventris/ is the Pages site of the ventris repository, so the card's link depends on that repository's name.
site/og.png and site/apple-touch-icon.png are rendered from the site's own copy, colors and fonts. Run this after you change the headline, the og:description or the palette. It needs Google Chrome.
python3 scripts/make-images.pyscripts/images.sha256 records what the images were last rendered from, so commit it with them.
The files in site/fonts/ are JetBrains Mono v2.304, cut down to the characters English text needs, without hinting or OpenType features. A character outside this set falls back to a system font, so add it here and to outsideFonts in test/site.spec.js, then run this on the release's fonts/webfonts files. It needs the fonttools and brotli Python packages.
pyftsubset JetBrainsMono-Regular.woff2 --unicodes='U+0020-007E,U+00A0,U+00B7,U+2013,U+2014,U+2018,U+2019,U+201C,U+201D,U+2026,U+2192' --layout-features='' --no-hinting --name-IDs='*' --flavor=woff2 --output-file=site/fonts/JetBrainsMono-Regular.woff2Do the same for JetBrainsMono-Medium.woff2.
Read CONTRIBUTING.md before you reuse code from another project.
BSD 3-Clause. See LICENSE.
The site uses JetBrains Mono, hosted here so that visitors make no third-party requests. The font is under the SIL Open Font License. See site/fonts/OFL.txt.
The GitHub mark in the header is from Octicons, under the MIT license. See site/licenses/octicons.txt.