isisneutronmuon.github.io

The source for the ISIS Neutron and Muon GitHub pages site. The live version can be viewed at https://isisneutronmuon.github.io/.

It is a Next.js project using:

• Bun
• Tailwind CSS and tailwindcss/typography for styling.
• MDX and remark to support Markdown content.

The development version uses a local node server to render the content.

The production version is compiled to a static set of pages using Next.js's support for static exports. The result requires only a standard webserver to serve the content and this is deployed to GitHub pages using a Github actions workflow.

Prerequisites

I don't have Bun installed

Visit https://bun.sh/docs/installation and install Bun using the appropriate method for your operating system.

I already have Bun installed

You're ready to go!

Install the dependencies

Clone this repository locally and change to the directory of the new clone. Install the dependencies specified in the package.json with:

bun install

Running the development version

While developing you should run the development server:

bun run dev

Open http://localhost:3000 with your browser to see the result. Once saved, any changes will be instantly reflected in the version presented in the browser allowing a fast-feedback loop during developing.

Building the production version

The production version is served as a set of static pages that do not require a running Node.js server. Build the pages with:

bun run build

The results appear in a ./dist subdirectory of the main project. These pages can be served with any standard webserver such as Nginx or Apache. Locally they can be checked using Node's own basic webserver:

serve ./dist

Adding/updating a software product

The software products listed on the Home page and Releases page are defined by configuration files in data/products. Edit and commit these files to add or change the information on these pages.