🌐 QGIS Website

👋 Welcome to QGIS.org!

This repository hosts the source code for the official QGIS Project website:
🌍 https://qgis.org

Here you'll find everything you need to build, develop, and contribute to the QGIS website.

⚠️ Note on Subdomain Websites

This repository is only for the main QGIS website (qgis.org).

If you are looking for the source code or want to contribute to QGIS subdomain websites, please visit their respective repositories below.
Each subdomain has its own codebase and contribution process:

• plugins.qgis.org (GitHub: QGIS-Plugins-Website) – QGIS Plugins Repository
• hub.qgis.org (GitHub: QGIS-Hub-Website) – QGIS Resources Hub
• feed.qgis.org (GitHub: qgis-feed) – QGIS Feed Manager
• planet.qgis.org (GitHub: QGIS-Planet-Website) – QGIS Planet Blog Aggregator
• members.qgis.org (GitHub: QGIS-Members-Website) – QGIS Sustaining Members Portal
• certification.qgis.org (GitHub: QGIS-Certification-Website) – QGIS Certification Programme Platform
• changelog.qgis.org (GitHub: QGIS-Changelog-Website) – QGIS Changelog Manager
• uc2025.qgis.org (GitHub: QGIS-UC-Website) – QGIS User Conference Website

📖 Table of Contents

Table of Contents

1. 🚀 Project Overview
2. 🚥 QA Status
3. 📜 License
4. 📂 Folder Structure
5. 🤖 Using 'AI' (Large Language Models)
6. 🛠️ Scripts Overview
7. 🧊 Using the Nix Shell
8. ✨ Contributing
9. 🙋 Have Questions?
10. 🧑‍💻👩‍💻 Contributors

🚀 Project Overview

🚥 QA Status

🪪 Badges

Badge	Description
	End-to-end tests status (Playwright)
	Deployment status to GitHub Pages
	Website availability status
	Repository license
	Open issues count
	Closed issues count
	Open pull requests count
	Closed pull requests count

⭐️ Project Stars

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

📂 Folder Structure

QGIS-Website/
  ├── 🖼️  assets/           # Mainly used to store the schedule.csv file
  ├── ⚙️  config/           # Hugo configuration files
  ├── 📄  content/          # Markdown content files (pages, posts)
  ├── 🗄️  data/             # Data files (YAML, JSON, TOML) for site variables
  ├── 📚  docs/             # Project documentation
  ├── 🖼️  img/              # Images files used by this README
  ├── 🧩  layouts/          # Hugo templates and partials
  ├── 🧪  playwright/       # Playwright end-to-end test scripts
  ├── 📦  public/           # Generated site output (after `hugo` build)
  ├── 🗂️  resources/        # Hugo-generated resources (e.g., minified assets)
  ├── 🛠️  scripts/          # Utility scripts for development/maintenance/harvesting
  ├── 💻  source/           # Mainly used to store the qugsneews.atom file
  ├── 📄  static/           # Static files served as-is (e.g., favicon, robots.txt)
  ├── 🎨  themes/           # Hugo themes
  ├── ⚙️  config.toml       # Main Hugo configuration file
  ├── 🤝  CONTRIBUTING.md   # Contribution guidelines
  ├── 🐍  fetch_feeds.py*   # Script to get sustaining members and other feeds to update our web site
  ├── 📜  LICENSE           # Project license
  ├── ⚙️  Makefile          # Build/Deployment automation commands
  ├── 📖  README.md         # Project overview and instructions
  ├── 📋  REQUIREMENTS.txt  # Python dependencies (pip)
  ├── 🐚  shell.nix         # Nix shell environment definition
  └── 💡  vscode.sh*        # VSCode helper script for Nix shell environment

🤖 Using 'AI' (Large Language Models)

We are fine with using LLM's and Generative Machine Learning to act as general assistants, but the following three guidelines should be followed:

1. Repeatability: Although we understand that repeatability is not possible generally, whenever you are verbatim using LLM or Generative Machine Learning outputs in this project, you must also provide the prompt that you used to generate the resource.
2. Declaration: Sharing the prompt above is implicit declaration that a machine learning assistant was used. If it is not obvious that a piece of work was generated, include the robot (🤖) icon next to a code snippet or text snippet.
3. Validation: Outputs generated by a virtual assistant should always be validated by a human and you, as contributor, take ultimate responsibility for the correct functionality of any code and the correct expression in any text or media you submit to this project.

🛠️ Scripts Overview

The scripts/ folder contains utility scripts to assist with data loading, and project maintenance. Below is a summary of each script:

Script Name	Description
fetch_feeds.py	Simple script to get sustaining members and other feeds and update our web site with them
vscode.sh	Launch VSCode with all settings and extensions needed to productively work on this project
scripts/get_commit_hash.sh	Get the current commit hash of this repository and write it in config/commit.toml for the website version.
scripts/changelog_harvest.py	Will create/update a visual-changelogs at content/project/visual-changelogs based on the data at data/conf.json.
scripts/hub_maps_harvest.py	Harvest maps data from https://maps.qgis.org
scripts/resize_image.py	Contains utilities to optimize images (resize, transform to webp, check validity).
scripts/sanitize_commercial_supports.py	Checks each supporter's URL at https://qgis.org/resources/support/commercial-support/ and removes each invalid ones.
scripts/update_donors_from_file.py	It will update the json file (data/donors.json) ordered alphabetically by the first name based on an input file.
scripts/update_donors.py	It will update the json file (data/donors.json) ordered alphabetically by the first name based on Stripe donations.
scripts/update-schedule.py	It will update data/conf.json and content/schedule.ics

✏️ Note: Run each script from the project root. Some scripts may require environment variables or configuration—see comments within each script for usage details.

🧊 Using the Nix Shell

Please refer to the Nix section in CONTRIBUTING.md.

✨ Contributing

We welcome contributions! Please read the CONTRIBUTING.md for guidelines on how to get started.

🙋 Have Questions?

Have questions or feedback? Feel free to open an issue or submit a Pull Request!

🧑‍💻👩‍💻 Contributors

• Tim Sutton – Original author and lead maintainer of the QGIS Website project
• Kontur Team – Responsible for the design and development of the current website version
• Lova Andriarimalala – Core developer and ongoing maintainer
• QGIS Contributors – See the full list of amazing contributors who have helped make this website possible.

Made with ❤️ by Tim Sutton (@timlinux), Lova Andriarimalala (@Xpirix) and QGIS Contributors.