Skip to content
This repository has been archived by the owner on Nov 30, 2024. It is now read-only.

Commit

Permalink
UPDATE - contribution guide; tweaks, naming, cleaning
Browse files Browse the repository at this point in the history
  • Loading branch information
MichalSvatos committed Nov 17, 2024
1 parent 7ec2681 commit df63ad4
Show file tree
Hide file tree
Showing 24 changed files with 310 additions and 234 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,14 @@

We're a small team educating people about digital rights, privacy, security, digital control, and other important topics to push the world towards a safer internet.

## Contributing

This website is using HTML, vanilla JavaScript, [Bulma.io](https://bulma.io/) framework and its components and static website generator [Jekyll](https://jekyllrb.com/).

#### Do you want to improve the project?
## Contributing

- Fork this repository
- Enable the Github Pages feature
- Edit the project with the improvements and features
- [Install and run it locally](#installation-and-local-development)
- **Read our [contribution guide 📝](contribution/index.md)**
- Edit the project to include improvements and/or features.
- Make a pull request with detailed changes
- Wait for our team to evaluate the changes

Expand All @@ -24,6 +23,7 @@ This website is using HTML, vanilla JavaScript, [Bulma.io](https://bulma.io/) fr
- Create an issue
- Fill the required questions in the form

---
## Installation and local development

Because we are using a static website generator, the installation requires a little bit more work.
Expand Down Expand Up @@ -57,6 +57,7 @@ The final step is to run `npm install`.

Run `bundle exec jekyll serve` and the site should be available at [http://localhost:4000](http://localhost:4000).

---
## Libraries & other projects included

- [Iconoir](https://iconoir.com/) - A high-quality selection of free open source icons
Expand Down
12 changes: 9 additions & 3 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,9 @@ wiki:
xmrAddress: "49H4jTvUY5zaX8qLpVBstJFR7ayTMxxU3UyWpGqUoBM4UzM2zwUHA2sJ9i3AhQYdaqhFmS8PDfWKn1Tea4SKU6haMTXG8qD"
openalias: "crypto@techlore.tech"

# Build settings
# -----------------------------------------
# Plugin settings
#
plugins:
- jekyll-sitemap

Expand All @@ -107,6 +109,9 @@ sass:
style: compressed
sourcemap: development

# -----------------------------------------
# Collection settings
#
collections:
videos:
output: true
Expand All @@ -124,6 +129,9 @@ collections:
permalink: /guides/:name
collections_dir: videos

# -----------------------------------------
# Sitemap configuration
#
defaults:
-
scope:
Expand All @@ -150,8 +158,6 @@ defaults:
values:
sitemap: false

# paginate: 3

# Exclude from processing.
# The following items will not be processed, by default.
# Any item listed under the `exclude:` key here will be automatically added to
Expand Down
54 changes: 6 additions & 48 deletions _data/_en/content.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,11 @@
# In the template then utilize the "replace" filter.
# Example:
# {% assign affiliatesUrl = site.data._en.navigation.hiddenNav.affiliates.url | absolute_url %}
# {{ t.resources.knowledgebase.disclaimer | replace: "[[affiliatesUrl]]", affiliatesUrl }}
# {{ site.data._en.knowledgebase-text.disclaimer | replace: "[[affiliatesUrl]]", affiliatesUrl }}
# Bold: <strong>bold text</strong>
# Italic: <i>italic text</i>
#
global:
description: "Techlore is educating people about digital rights, privacy, security, digital control, and other important topics to push the world towards a safer internet."
patreons:
title: "Sending 🤍 to our gold [patreons]([[patreonLink]])"
platforms:
techlorian: "Techlorian"
youtube: "YouTube"
Expand Down Expand Up @@ -59,7 +56,8 @@ global:
# HOMEPAGE
#
home:
hero: ""
patreons:
title: "Sending 🤍 to our gold [patreons]([[patreonLink]])"
newestVideos: "Newest videos"
hotTopics: "Hot topics in our community"
team:
Expand All @@ -68,6 +66,9 @@ home:
# -----------------------------------------
# RESOURCES section and page
#
# Knowledgebase sources: - text in `knowledgebase.yml`
# - data in `/knowledgebase` folder
#
resources:
title: "Resources"
section:
Expand All @@ -78,49 +79,6 @@ resources:
tools:
title: "Tools that can help you"
desc: "Check out our curated list of useful resources to help you stay private and secure"
knowledgebase:
affil: "Affiliate link"
disclaimer: "Affiliate Link: Some services link to their official site, with a separate affiliate link if you choose to support Techlore. View our strict requirements <a href=\"https://discuss.techlore.tech/pub/sponsors-affiliates\" target=\"blank\">here</a>. To view all affiliates, visit <a href=\"[[affiliatesUrl]]\">here.</a>"
favorite: "marks a favorite. They don't represent every threat model and shouldn't be over-analyzed."
external: "Explore our curated list of organizations and tools that offer valuable insights, advocacy, and support for protecting your online freedoms."
sections:
software: "Software, hardware and applications"
operating-systems: "Operating systems"
other-services: "Other services"
external-resources: "External resources"
categories:
web-browsers: "Web Browsers"
password-managers: "Password Managers"
totp-2fa: "TOTP 2FA"
encryption: "Encryption"
firewalls: "Firewalls"
applications: "Applications"
desktop: "Desktop"
android: "Android"
expendable-liveos: "Expendable/LiveOS"
search-engines: "Search engines"
vpns: "VPNs"
dns: "DNS"
messengers: "Messengers"
email: "Email"
aliasing: "Aliasing"
cloud-providers: "Cloud providers"
notes-a-docs: "Notes & docs"
cryptocurrencies: "Cryptocurrencies"
hardware-2fa: "Hardware 2FA"
webhosting-vps: "Webhosting/VPS"
networking: "Networking"
other-tools: "Other tools"
guides: "Guides"
digital-rights: "Digital rights"
creators: "Creators"
labels:
android: "Android"
ios: "iOS"
desktop: "Desktop"
official: "Official web"
youtube: "YouTube channel"
related: "May come in handy"


# -----------------------------------------
Expand Down
File renamed without changes.
42 changes: 42 additions & 0 deletions _data/_en/knowledgebase-text.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
affil: "Affiliate link"
disclaimer: "Affiliate Link: Some services link to their official site, with a separate affiliate link if you choose to support Techlore. View our strict requirements <a href=\"https://discuss.techlore.tech/pub/sponsors-affiliates\" target=\"blank\">here</a>. To view all affiliates, visit <a href=\"[[affiliatesUrl]]\">here.</a>"
favorite: "marks a favorite. They don't represent every threat model and shouldn't be over-analyzed."
external: "Explore our curated list of organizations and tools that offer valuable insights, advocacy, and support for protecting your online freedoms."
sections:
software: "Software, hardware and applications"
operating-systems: "Operating systems"
other-services: "Other services"
external-resources: "External resources"
categories:
web-browsers: "Web Browsers"
password-managers: "Password Managers"
totp-2fa: "TOTP 2FA"
encryption: "Encryption"
firewalls: "Firewalls"
applications: "Applications"
desktop: "Desktop"
android: "Android"
expendable-liveos: "Expendable/LiveOS"
search-engines: "Search engines"
vpns: "VPNs"
dns: "DNS"
messengers: "Messengers"
email: "Email"
aliasing: "Aliasing"
cloud-providers: "Cloud providers"
notes-a-docs: "Notes & docs"
cryptocurrencies: "Cryptocurrencies"
hardware-2fa: "Hardware 2FA"
webhosting-vps: "Webhosting/VPS"
networking: "Networking"
other-tools: "Other tools"
guides: "Guides"
digital-rights: "Digital rights"
creators: "Creators"
labels:
android: "Android"
ios: "iOS"
desktop: "Desktop"
official: "Official web"
youtube: "YouTube channel"
related: "May come in handy"
2 changes: 1 addition & 1 deletion _data/_en/patreons.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# You can have as many patreons as you want. Just be aware about the space it will occupy on the homepage
#
-
name: "Brightside"
name: "BRIGHTSIDE"
-
name: "Clark"
-
Expand Down
47 changes: 47 additions & 0 deletions _includes/c_goincognitotable-column.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{% comment %}
goincognitotable (Go Incognito courses) - columns -----------------------------------------
Data source: _includes/goincognitotable.html
Parameters:
isPremium (boolean): activating premium visuals (class + button class)
{% endcomment %}

{% assign data = include.data %}

<div class="goincognitotable__column column has-text-centered is-flex is-flex-direction-column is-align-items-center is-gap-2 p-6{% if include.isPremium %} goincognitotable__column--premium has-glare{% endif %}">
{% if data.icon %}
{% include e_render-svg-icon.html icon=data.icon inline=true %}
{% endif %}

{% if data.title %}
<h4 class="goincognitotable__title">{{ data.title }}</h4>
{% endif %}

{% if data.desc %}
<p class="goincognitotable__desc">{{ data.desc }}</p>
{% endif %}

{% if data.sellingPoints.size > 0 %}
<ul class="goincognitotable__list listless marginless">
{% for point in data.sellingPoints %}
<li class="goincognitotable__list-item marginless pt-2 pb-2">{{ point }}</li>
{% endfor %}
</ul>
{% endif %}

{% if data.buttons.size > 0 %}
{% for button in data.buttons %}
<a href="{{ button.url }}" class="goincognitotable__button button{% if include.isPremium %} is-warning{% endif %}">{{ button.text }}</a>
{% endfor %}
{% endif %}

{% if data.note %}
<div class="goincognitotable__footnote columns is-flex">
<div class="column is-flex-grow-0 p-1">
{% include e_render-svg-icon.html icon="info-circle" inline=true dimension=25 %}
</div>
<div class="column has-text-left is-size-7 p-1">
<p><i>{{ data.note }}</i></p>
</div>
</div>
{% endif %}
</div>
2 changes: 1 addition & 1 deletion _includes/c_hero-banner.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ <h1>
</h1>
{% include c_patreons.html isHomepage=true %}
</div>
<div class="column is-half-desktop is-two-thirds-fullhd">
<div class="column is-half-desktop is-two-thirds-fullhd" aria-hidden="true">
<div class="hero-banner__scramble is-size-7-mobile is-size-7-tablet is-size-5-desktop is-size-2-fullhd is-flex is-flex-direction-column is-family-monospace">
<span>tgvrzpjrksoyvvowatoghfdrb</span>
<span>zdclrsrpiejeqshwctltymumkikewwqy</span>
Expand Down
4 changes: 2 additions & 2 deletions _includes/c_knowledgebase-item.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@ <h4 class="knowledgebase-item__title is-align-items-center is-flex is-gap-1">
{% if include.item.affil %}
<a href="{{ include.item.affil }}" class="knowledgebase-item__affil button is-primary is-small is-gap-1.5 is-touch-friendly" target="_blank">
{% include e_render-svg-icon.html icon="link" dimension="25" class="icon" inline=true %}
{{ t.resources.knowledgebase.affil }}
{{ site.data._en.knowledgebase-text.affil }}
</a>
{% endif %}
{% if include.item.labels.size > 0 %}
{% for label in include.item.labels %}
{% assign link = label[1] %}
{% assign text = label[0] %}
<a href="{{ link }}" class="knowledgebase-item__button button is-primary is-outlined is-small is-touch-friendly" target="_blank">{{ t.resources.knowledgebase.labels[text] }}</a>
<a href="{{ link }}" class="knowledgebase-item__button button is-primary is-outlined is-small is-touch-friendly" target="_blank">{{ site.data._en.knowledgebase-text.labels[text] }}</a>
{% endfor %}
{% endif %}
</div>
Expand Down
2 changes: 1 addition & 1 deletion _includes/c_knowledgebase.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

{% if include.related.size > 0 %}
{% include c_related-links.html
title=t.resources.knowledgebase.related
title=site.data._en.knowledgebase-text.related
links=include.related
%}
{% endif %}
Expand Down
2 changes: 1 addition & 1 deletion _includes/c_patreons.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<div class="patreons is-flex is-gap-2 is-flex-direction-column">
<div class="patreons__title">
{% assign patreonLink = site.data._en.navigation.mainNav.support.url | absolute_url | append: '#paid' %}
{{ site.data._en.content.global.patreons.title | replace: "[[patreonLink]]", patreonLink | markdownify }}
{{ site.data._en.content.home.patreons.title | replace: "[[patreonLink]]", patreonLink | markdownify }}
</div>
<div class="patreons__tags{% if include.isHomepage %} patreons__tags--homepage{% endif %} tags">
{% for patreon in patreons %}
Expand Down
47 changes: 0 additions & 47 deletions _includes/c_pricetable-column.html

This file was deleted.

16 changes: 16 additions & 0 deletions _includes/goincognitotable.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{% comment %}
goincognitotable (Go Incognito courses) -----------------------------------------
Data source: _data/_en/goincognitotable.yml
{% endcomment %}

{% include variables.html %}

<div class="goincognitotable columns has-2-columns">
<img src="{{ '/assets/logos/techlore-logo-incognito-v5.svg' | absolute_url }}" class="goincognitotable__logo has-radius-rounded" loading="lazy" alt="Logo - {{ t.goincognito.title }}">

{% assign dataFree = site.data._en.goincognitotable.free %}
{%- include c_goincognitotable-column.html data=dataFree -%}

{% assign dataPremium = site.data._en.goincognitotable.premium %}
{%- include c_goincognitotable-column.html data=dataPremium isPremium=true -%}
</div>
16 changes: 0 additions & 16 deletions _includes/pricetable.html

This file was deleted.

Loading

0 comments on commit df63ad4

Please sign in to comment.