This project uses Hugo and Hugo template Docsy to build the OpenFunction website.

Contributions of any kind are welcome!

First, create your own fork of the repository.

Then, clone your fork and enter into it:

git clone https://github.com/OpenFunction/website.git
cd website

You will need to install Hugo to build the website in order to publish it as static content.

Go to the Hugo releases place and download the hugo_extended version that better suits your OS (version 0.75+).

EXTENDED version is MANDATORY to properly build the static content!

Note: If you install Hugo on Windows, you need to add environment variables for the exe file of Hugo. Execute hugo version to view if the installation is successful.

When you have installed Hugo, then run:

hugo server

Now you can preview the website in your browser using http://localhost:1313/.

Open a pull request (PR) to contribute to our website. Please use DCO sign-off when you submit a pr. Refer to the command below (add -s):

git commit -s -m "xxx"