Skip to content

Add filter to do a basic email obfuscation - #340

Merged
vgvassilev merged 2 commits into
compiler-research:masterfrom
imorlxs:email-obfuscation
Nov 10, 2025
Merged

Add filter to do a basic email obfuscation#340
vgvassilev merged 2 commits into
compiler-research:masterfrom
imorlxs:email-obfuscation

Conversation

@imorlxs

@imorlxs imorlxs commented Nov 9, 2025

Copy link
Copy Markdown
Contributor

Email Obfuscation Implementation

Context

This implementation addresses the email protection concern raised in the Compiler Research Group Discord (November 7, 2025). The discussion highlighted the need to protect team members' email addresses from automated harvesting while maintaining human readability.

NOTE: This PR only applies the obfuscation in the members emails. The footer ones or any other email hardcoded is not obfuscated.

Implementation Details

Added a reusable Jekyll include component that transforms email addresses using simple text substitution:

  • @ becomes [at]
  • . becomes [dot]

For example:

user@example.com → user[at]example[dot]com

Usage

To display an obfuscated email address in any template, use:

{% include email-display.html email=member.email %}

Implementation Details

The core logic is implemented in email-display.html:

{% assign obfuscated_email = include.email | replace: "@", "[at]" | replace: ".", "[dot]" %}
<p><i>email: {{ obfuscated_email }}</i></p>

Security Note

This implementation provides basic protection against automated email harvesting while maintaining human readability. Future enhancements could include JavaScript-based solutions or contact forms for additional security.

@imorlxs
imorlxs marked this pull request as draft November 9, 2025 18:14
@imorlxs imorlxs changed the title Add plugin to obfuscate email Add filter to do a basic email obfuscation Nov 9, 2025
@imorlxs
imorlxs marked this pull request as ready for review November 9, 2025 18:34
check-spelling run (pull_request) for email-obfuscation

Signed-off-by: check-spelling-bot <check-spelling-bot@users.noreply.github.com>
on-behalf-of: @check-spelling <check-spelling-bot@check-spelling.dev>

@vgvassilev vgvassilev left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @imorlxs!

@vgvassilev
vgvassilev merged commit 9b83926 into compiler-research:master Nov 10, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants