This repository builds the documentation found here: https://openmetal.io/docs/manuals
All documentation exists within the docs/
directory. Simply create or update the markdown files, and the documentation site will be updated after the changes have been merged into main.
This website is built using Docusaurus 2, a modern static website generator.
This readme assumes that you already have node 14 or greater installed. To perform this install on Ubuntu, we run the following
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
nvm install node
npm install --global yarn
yarn
yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
yarn build
This command generates static content into the build
directory and can be
served using any static contents hosting service.
Using SSH:
USE_SSH=true yarn deploy
Not using SSH:
GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way
to build the website and push to the gh-pages
branch.