Editing the documentation

This page covers how you should edit pages on this website.

Setup

Fork the repository, then:

git clone https://github.com/USERNAME/website.git
cd website
npm i

You will need to install Hugo, version 0.145.0, to be able to run the static site generator and see your changes:

npm run dev  # launches a server at http://localhost:1313

Colouring ArkScript code

We can not use the ``` syntax, as Hugo relies on Chroma, and we would have to patch Chroma, then wait for Hugo to pick up the update.

A homemade shortcode can instead be used, nearly in the same way:

{{< highlight_arkscript >}}
(math:sin 0.5421)

(list:forEach the-list (fun (element) (...)))

(console:color "red")
{{< /highlight_arkscript >}}

You will also have to include the JS scripts so that Rainbow.js is loaded:

{{< highlight_scripts >}}