https://github.com/fodydev/fodydev.org
The website of the FodyDev organisation.
https://github.com/fodydev/fodydev.org
Last synced: 5 months ago
JSON representation
The website of the FodyDev organisation.
- Host: GitHub
- URL: https://github.com/fodydev/fodydev.org
- Owner: fodydev
- License: other
- Created: 2025-06-16T22:48:56.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-12-25T19:15:09.000Z (6 months ago)
- Last Synced: 2025-12-27T06:14:36.858Z (6 months ago)
- Language: SCSS
- Homepage: https://fodydev.org
- Size: 1.02 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://creativecommons.org/licenses/by/4.0/)
[](https://gohugo.io/)
# FodyDev website
This repo houses the assets used to build the website for [FodyDev](https://fodydev.org/) 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](https://fodydev.org/community).
We encourage people to [join the community](https://fodydev.org/community) and get started with contributions to the different FodyDev initiatives.
## 🧩 Editing the site
This site is built using the [Hugo](https://gohugo.io) static site generator. The site uses the [Dot-Org Theme for Hugo](https://github.com/cncf/dot-org-hugo-theme) as a base and then has its own customisations.
In order to build or locally develop the website, you'll need to install [Hugo](https://gohugo.io) and [node.js](https://nodejs.org/en).
If you don't have them installed, you can install them via [brew.sh](https://brew.sh).
```bash
# 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:
```bash
git submodule update --init --recursive
```
3. Install dependencies:
```bash
npm install
```
4. Build the site:
```bash
npm run build
```
5. Start the local server with live reload:
```bash
npm run start
```
## Other npm commands for working with a local instance
- `npm run dev:start` - Starts the local dev environment using exampleSite
- `npm run dev:start:with-pagefind` - Starts the local dev environment using exampleSite with working pagefind search
- `npm run dev:build` - Builds the site using exampleSite
### To run in docker
As mentioned above, fork and clone this repository, run `git submodule update --init --recursive`, then run following:
```bash
./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](https://gohugo.io/getting-started/directory-structure/).
## Updating the theme
Some brief notes on how to update the theme:
From the site root:
```
git submodule init
git submodule update
cd themes/dot-org-hugo-theme
git fetch
git checkout main
git pull origin main
cd ../..
git add themes/dot-org-hugo-theme
git commit -m "Updated submodule to the latest version of dot-org-hugo-theme" -s
```