Liquid Metal Website

This site is built using Docusaurus.

It is published to github-pages when there are new pushes to main. Do not attempt to publish manually.

Local development:

git clone https://github.com/liquidmetal-dev/site
cd site

Because I develop on multiple machines over SSH, I have configured the site to run from 0.0.0.0. If you do not need this (ie the machine you are typing on is the same as the one on which you are looking at the UI), open package.json and edit line 7, removing the --host 0.0.0.0.

npm ci
npm run start

Navigate to localhost:3000 (or http://<device ip>:3000 if you did not change package.json).

Contributing

Please, please do this 😅.

There are so many docs to write and so few hours in the day and I am one person!

So, if you find a typo, instead of opening an issue... why not submit a quick PR?

A good guide for the sort of content found in good docs can be found here.

I have zero experience with JS and React and... stuff, so if anyone wants to improve the look and functionality of the site that would be sweet.

Developing the site is pretty easy:

Fork this repo
Create a feature branch
Follow the instructions at the top of this page to start your local environment
Make your changes
Check they look okay, take some screenshots if you changed more than just text
Open a PR, include your screenshots
Profit