Skip to content

shipwright-io/website

Folders and files

NameName
Last commit message
Last commit date
Aug 9, 2023
Feb 25, 2025
Sep 11, 2020
Sep 19, 2024
Apr 9, 2025
Feb 25, 2025
Sep 19, 2024
Sep 19, 2024
Mar 17, 2021
Feb 25, 2025
Feb 25, 2025
May 23, 2022
Sep 19, 2024
Sep 22, 2020
Feb 25, 2025
Mar 3, 2025
Mar 11, 2025
Feb 17, 2025
Feb 17, 2025
Mar 10, 2025
Mar 11, 2025
Dec 13, 2024
Oct 6, 2023

Shipwright Documentation

Netlify Status

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.
  • Go SDK v1.21 or higher.

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

$ git clone 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.