Skip to content

nate-double-u/OpenFunction-openfunction.dev

 
 

Repository files navigation

OpenFunction Website

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

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>/website.git
    cd website
    

Build and preview the website

Pre-requisites

Environment setup

  1. Ensure pre-requisites are installed
  2. Clone repository
  3. Change to website directory: cd website
  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 the website locally

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

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"

About

OpenFunction Website

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 91.8%
  • Shell 4.0%
  • SCSS 3.9%
  • Dockerfile 0.3%