Skip to content

fodydev/fodydev.org

Repository files navigation

License: CC BY 4.0 Site

FodyDev website

This repo houses the assets used to build the website for FodyDev at https://fodydev.org.

📝 Adding Resources

FodyDev operates through different working groups and initiatives, each of them with their unique contribution guidelines and communication channels.

We encourage people to join the community and get started with contributions to the different FodyDev initiatives.

🧩 Editing the site

This site is built using the Hugo static site generator. The site uses the Dot-Org Theme for Hugo as a base and then has its own customisations.

In order to build or locally develop the website, you'll need to install Hugo and node.js.

If you don't have them installed, you can install them via brew.sh.

# macOS
brew install hugo node

Then following these instructions:

  1. Clone this repo to a local directory on your computer.

  2. Navigate to the newly created directory, and pull in the theme:

git submodule update --init --recursive
  1. Install dependencies:
npm install
  1. Build the site:
npm run build:dev
  1. Start the local server with live reload:
npm run dev:start

Other npm commands for working with a local instance

  • npm run dev:start - Starts the local dev environment (without pagefind)
  • npm run dev:build - Builds the site for dev environment
  • npm run dev:prod - Builds the site for prod envirionment

To run in docker

As mentioned above, fork and clone this repository, run git submodule update --init --recursive, then run following:

./run-hugo-in-docker.sh

This command should give an address you can visit on your local machine to see the local copy of your site. Typically this is localhost:1313. Just navigate to http://localhost:1313 in your browser and you should see the site running.

If modifying the theme files, you should never edit the theme that is imported via Git Submodule, as otherwise the changes will be overwritten or lost the next time the theme is updated. Changes should be made in override files inside the root directory as this will override the theme directory. Read docs.

Updating the theme

From the site root:

git submodule update --init --recursive

About

The website of the FodyDev organisation.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published