Skip to content

SignalK/signalk.github.io

Repository files navigation

SignalK.org

This is the repository for the Signal K website.

Contributing

The website is built with Astro and hosted on GitHub Pages.

To run it locally, you need to have Node.js installed.

git clone https://github.com/SignalK/signalk.github.io
cd signalk.github.io
npm install
npm start

This will start the server on localhost:4321.

After you make changes, you can automatically fix some errors and check for others by running:

npm run fix

Creating a new blog post

To create a new blog post, run:

script/generate "Title of the new post"

This will create a new file in _posts with the current date and a template for the post. Write a draft, and open up a pull request to get reviewed.