lukasz-pyrzyk/wrocnet.org

★ 0Forks 4RubyGitHub ↗Compare

README

Wroc.NET – website

The wrocnet.org website – Wrocław .NET User Group.

Built with Jekyll and the Minimal Mistakes theme.

Local development

macOS

  1. Install Ruby via Homebrew (the system Ruby is too old):

    brew install ruby
    export PATH="$(brew --prefix ruby)/bin:$PATH"

    Add the export PATH line to your ~/.zshrc to make it permanent.

  2. Install Bundler and dependencies:

    gem install bundler
    bundle install
  3. Start the dev server:

    bundle exec jekyll serve --livereload

Windows

  1. Install Ruby via RubyInstaller for Windows (choose the Ruby+Devkit version ≥ 3.0). Run the ridk install step at the end of the installer.

  2. Open a new Command Prompt or PowerShell window and install dependencies:

    gem install bundler
    bundle install
  3. Start the dev server:

    bundle exec jekyll serve --livereload

The site will be available at http://localhost:4000.

CI validation checks (local)

To run the same checks as CI before opening a PR:

Prerequisite for step 1: install yamllint (for example: python -m pip install yamllint).

  1. Lint YAML files:

    yamllint -c .yamllint _data _config.yml
  2. Build Jekyll in strict front matter mode:

    bundle exec jekyll build --strict_front_matter
  3. Validate generated HTML, internal links, and images:

    bundle exec htmlproofer ./_site --disable-external --no-enforce-https

Project structure

Path Description
_config.yml Main Jekyll and theme configuration
_data/ Static data: navigation, organizers, schedule
_posts/ Meeting posts (format: YYYY-MM-DD-NR-spotkanie-*.md)
_pages/ Static pages (about, organizers, etc.)
_includes/ Overridden theme partials (masthead, hero)
_sass/ Custom color skin (_wrocnet.scss)
assets/ Images, logo, presentation files (PDF/PPTX)

Adding a new meeting post

Create a file in _posts/ following the naming convention:

_posts/YYYY-MM-DD-NR-spotkanie-wroclawskiej-grupy-net.md

Minimal front matter:

---
title: "NR. spotkanie Wrocławskiej Grupy .NET"
date: YYYY-MM-DD
categories: spotkania
tags:
   - offline
header:
  teaser: /assets/images/logo.png
---

Every post must have exactly one format tag: offline for regular in-person meetings, online for regular online meetings, or inne for special/non-numbered events.

Contributors

lukasz-pyrzykCopilottozawadzki-avanade

Issues