OpenFunction Website

openfunction.dev is OpenFunction's website which is built with Hugo and Hugo template Docsy.

Contribute

Contributions of any kind are welcome!

Fork and clone the repository

1. Fork the repository.

2. Run the following commands to clone your fork and enter into it. Make sure you replace <Your GitHub ID> with your GitHub ID.

   git clone https://github.com/<Your GitHub ID>/openfunction.dev.git
   cd openfunction.dev
   

Build and preview openfunction.dev

Pre-requisites

• Hugo extended version
• Node.js

Environment setup

1. Ensure pre-requisites are installed
2. Clone repository
3. Change to openfunction.dev directory: cd openfunction.dev
4. Add Docsy submodule: git submodule add https://github.com/google/docsy.git themes/docsy
5. Update submodules: git submodule update --init --recursive
6. Install npm packages: npm install

Running openfunction.dev locally

After you setup the environment, run the following command:

hugo server -D

Now you can preview openfunction.dev in your browser at http://localhost:1313/.

Open a pull request

Open a pull request (PR) to contribute to openfunction.dev. Use DCO sign-off when you submit a PR by running the command below (add -s):

git commit -s -m "xxx"