This project uses Hugo and Hugo template Docsy to build the OpenFunction website.
Contributions of any kind are welcome!
-
Fork the repository.
-
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>/website.git cd website
- Ensure pre-requisites are installed
- Clone repository
- Change to website directory:
cd website - Add Docsy submodule:
git submodule add https://github.com/google/docsy.git themes/docsy - Update submodules:
git submodule update --init --recursive - Install npm packages:
npm install
After you setup the environment, run the following command:
hugo server -D
Now you can preview the website in your browser at http://localhost:1313/.
Open a pull request (PR) to contribute to our website. Use DCO sign-off when you submit a PR by running the command below (add -s):
git commit -s -m "xxx"