Eth Docker Documentation Portal

This repository houses all the documentation pertaining to the Eth Docker tool. It is generated with Docusaurus.

Below are steps for initialising and reproducing this portal for development.

Dependencies

1. The latest version of Node installed.

   You have to be on Node >= 20.x. This is the default version on Ubuntu 24.04 "Noble Numbat" or later, and Debian 13 "Trixie" or later.

Installation

1. Clone this repository.
2. Enter the newly cloned repo and enter the website directory.
3. Issue the command npm ci
4. Wait for the installation process to complete.

Version update

1. Enter the website directory in this repo
2. Update package.json if the Docusaurus major version changed
3. Run npm update
4. Check that the website will still load with npm start

Running the development server

Do this every time the website/docs directory had changes, to ensure there are no breaking changes such as outdated links

1. From within the website directory, run the local web server using yarn start or npm start.

2. Load the example site at http://localhost:3000 if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.

   You should see the example site loaded in your web browser. There's also a LiveReload server running, and any changes made to the docs and files in the website directory will cause the page to refresh.

Building Static HTML Pages

To create a static build of the documentation portal, run the following script from the website directory:

yarn run build # or `npm run build`

This will generate a build subdirectory within the website directory, containing the .html files from all of the docs and other files included in pages.