Shipwright Documentation

This repository contains the assets needed to build the Shipwright website and documentation.

Using this repository

This website is built using Docusaurus, a modern static website generator.

Installation

yarn

Local Development

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.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Contributing

We are happy to have you join us and contribute to the Shipwright website! Please review the Contributing Guide for more information.

License

Licensed under CC BY 4.0.