Shipwright Documentation

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

Using this repository

You can run the website locally using the Hugo static site generator.

Getting Started

To use this repository, you need the following installed locally:

• npm - this can be obtained by installing Node.js on your system
• Hugo - be sure to install the extended version.
• Ruby

Once installed, clone the repository and navigate to the directory:

$ git clone --recurse-submodules --depth 1 https://github.com/shipwright-io/website.git
$ cd website

Then install any additional dependencies by running make install

Running the website locally

To run the website locally, use Hugo's server command:

$ hugo -t docsy server

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.