This repository contains the MBX website, built as a Vite + React single-page app. Page content lives in YAML and Markdown files under content/, so routine site updates can usually be made without editing React components.
MBX development is supported by the U.S. National Science Foundation through Award No. 2311260, “Frameworks: Data-Driven Software Infrastructure for Next-Generation Molecular Simulations.”
All editable page data lives in content/:
content/
├── pages/
│ ├── home.yaml
│ ├── about.yaml
│ └── faq.yaml
├── publications/
│ └── index.yaml
├── updates/
│ └── index.yaml
└── tutorials/
├── index.md
├── compilation-and-installation.md
├── testing.md
└── …other tutorials
pages/home.yaml: home pagesubheadingand Markdowninfo.pages/about.yaml:currentandformercontributor lists. People havename,role, and optionalimage. Use an image filename frompublic/people/; omitimageor use""for no photo.pages/faq.yaml:itemswithquestionand Markdownanswer.publications/index.yaml: key publicationitems,applications_intro, andapplications. Publications havetitle,authors,date,citation,link,description,img_src, and optionalrelationship. Use an image filename frompublic/publications/, or""for no image. Descriptions remain plain text.updates/index.yaml: an orderedupdateslist withversion,date,releaseNotes(typeanddescription), andchangelog. Optional fields includetype,patch_notes,download_link, andshowDownloadCount. Release notes and changelog entries remain plain text. Update pages and downloads retain their existing GitHub link defaults; explicit links override those defaults.
Use spaces for YAML indentation, never tabs. Keep dates and versions quoted as strings. Use |- for multiline Markdown: line breaks and blank lines are preserved, and the final newline is stripped. Use | when a final newline is wanted. Indent every line of the block beneath its field, including Markdown lists, tables, and code fences.
items:
- question: How do I install MBX?
answer: |-
See the [installation tutorial](/tutorials/compilation-and-installation).
1. Install the prerequisites.
2. Compile MBX.tutorials/index.md contains the introduction and requires a heading in its YAML front matter. Each other .md file in that directory is a tutorial with heading, path, and order metadata:
---
heading: Compilation and Installation
path: compilation-and-installation
order: 1
---
## Compilation and Installation
Write normal Markdown here, including tables, code blocks, and relative links.To add a tutorial, create <path>.md in content/tutorials/. Use a unique, lowercase, hyphen-separated path and a unique positive integer order. Navigation sorts by order, so gaps are allowed. The path sets the URL (/tutorials/<path>); keep it unchanged when renaming a heading to preserve existing links. The introduction always appears first and is served at /tutorials.
The Vite content plugin validates content and bundles plain data for the site. Missing fields, incorrect types, malformed YAML, and duplicate tutorial paths or orders produce errors naming the source file and field. Content edits, additions, and deletions refresh the running development site. React components access the validated groups through lib/content.ts; parsers run only in the build tooling.
Vite serves files in public/ from the site root.
- Site assets such as the logo live directly under
public/. - Contributor photos live under
public/people/. - Publication figures live under
public/publications/. - Do not include
public/in content image paths.
Examples:
image: fpaesani.pngimg_src: pub202.pngNode.js 24.18.0 (LTS) or newer is required.
Install dependencies:
npm installRun the development server:
npm run devOpen the local site:
http://localhost:5173
npm run dev: start the Vite development server.npm run build: type-check and build the production site intodist/.npm run serve: preview the production build locally.npm run lint: run the TypeScript type check.npm run format: format the repository with Prettier.npm run test: run Playwright tests.npm run test:e2e: run Playwright tests.npm run test:content: run content-loader validation tests.npm run check-git-hooks: verify the secret-scan git hooks.
The build and lint scripts both run tsc --noEmit. Prettier is available through npm run format.
Playwright tests live under e2e/ and tests/e2e/. CI installs Playwright browsers before running the test suite.
The site builds as a Vite single-page app and can be deployed to any static host that serves dist/.
The GitHub Actions workflows currently:
- run type checks, build, and Playwright tests on pushes and pull requests to
mainormaster; - deploy the Vite build to GitHub Pages on pushes to
main; - copy
dist/index.htmltodist/404.htmlso browser-routed pages work on GitHub Pages.