Skip to content

Latest commit

 

History

History
49 lines (28 loc) · 2.29 KB

README.md

File metadata and controls

49 lines (28 loc) · 2.29 KB
Raw

Adoptium Site

Netlify Status codecov OpenSSF Scorecard

This repository contains the source code for https://adoptium.net.

The main branch contains the source code necessary for development. The production site is hosted on Netlify which also supports pull request staging.

Tech Stack

This is is a Node.js / npm driven stack with AsciiDoc used for static content and Gatsby as the rendering engine etc.

How to develop locally

This assumes you already have Node.js and npm installed. Node.js version 18 or above is required. We recommend using nvm to manage your versions.

  1. Install your dependencies

    npm install

  2. Start the site up. Gatsby will build all of the various parts of the site (Asciidoc etc). Note that this command takes some time to execute.

    npm start

  3. If you need more memory (FATAL ERROR: Ineffective mark-compacts near heap limit Allocation failed - JavaScript heap out of memory)

    export NODE_OPTIONS=--max-old-space-size=4096

  4. Open the source code and start editing!

    Your site is now running at http://localhost:8000!

    Note: You'll also see a second link:http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

    Open the directory in your code editor of choice and edit relevant files under the src/ directory. Save your changes and the browser will update in real time!

Configuring the build

gatsby-config.ts is effectively your build script and gatsby-node.ts is where the Asciidoc rendering takes place.

How to contribute

See CONTRIBUTING.md