DMR Documentation

Documentation site for DMR, the Dynamic MPI Reconfiguration library by the Barcelona Supercomputing Center. Built with Docusaurus.

Setup

With Nix (recommended)

A flake.nix is provided with Node 22 and all required tools. Requires Nix with flakes enabled.

nix develop
npm install

Manual

Requires Node.js >= 22.12.

npm install

Development server

npm start

Opens at http://localhost:3000. The site hot-reloads on file changes.

Build

npm run build

Generates static files in build/. The prebuild script runs automatically and generates static/llms.txt from the docs.

Deployment

The site deploys automatically to GitHub Pages on every push to master via the workflow in .github/workflows/deploy.yml.

To deploy manually:

BASE_URL=/dmr_doc/ npm run build
# then push the build/ folder to the gh-pages branch

Structure

docs/               English documentation source
i18n/es/            Spanish translations
src/                Homepage and custom components
static/             Static assets (favicon, images, llms.txt)
viz/                Jupyter notebook for analytics visualization

Adding or editing pages

All content is written in Markdown (.md) or MDX (.mdx). Drop files in the appropriate docs/ subdirectory and they appear in the sidebar automatically via autogenerated sidebar config.

For Spanish translations, mirror the file structure under i18n/es/docusaurus-plugin-content-docs/current/.