Skip to content

Commit

Permalink
Add Editor Config File and clean all files based on .editorconfig
Browse files Browse the repository at this point in the history
  • Loading branch information
kmutahar committed May 17, 2021
1 parent c178010 commit d54e496
Show file tree
Hide file tree
Showing 17 changed files with 502 additions and 441 deletions.
17 changes: 17 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# http://editorconfig.org

root = true

[*]
charset = utf-8
indent_style = space
indent_size = 4
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.gemspec]
indent_size = 2

[*.yml]
indent_size = 2
42 changes: 21 additions & 21 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
plugins:
- jekyll-sitemap
- jekyll-seo-tag

# SEO Stuff
author: Kev Quirk
title: 512KB Club
tagline: A showcase of lightweight websites.
description: The 512KB Club is an exclusive list of web pages weighing less than 512 kilobytes.
lang: en
locale: en_GB
url: "https://512kb.club"
baseurl: ""
permalink: :title

# Syntax Highlighting
highlighter: rouge

# Netlify redirects
include:
- _redirects
plugins:
- jekyll-sitemap
- jekyll-seo-tag

# SEO Stuff
author: Kev Quirk
title: 512KB Club
tagline: A showcase of lightweight websites.
description: The 512KB Club is an exclusive list of web pages weighing less than 512 kilobytes.
lang: en
locale: en_GB
url: "https://512kb.club"
baseurl: ""
permalink: :title

# Syntax Highlighting
highlighter: rouge

# Netlify redirects
include:
- _redirects
18 changes: 9 additions & 9 deletions _includes/blue-team.html
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<ul class="blue">
{% for item in site.data.blue-team %}
<li>
<span class="before" style="--data-size:{{ item.size }};"></span>
<span class="after">{{ item.size }} KB</span>
<a class="site" target="blank" href="{{ item.url }}">{{ item.domain }}</a>
</li>
{% endfor %}
</ul>
<ul class="blue">
{% for item in site.data.blue-team %}
<li>
<span class="before" style="--data-size:{{ item.size }};"></span>
<span class="after">{{ item.size }} KB</span>
<a class="site" target="blank" href="{{ item.url }}">{{ item.domain }}</a>
</li>
{% endfor %}
</ul>
23 changes: 14 additions & 9 deletions _includes/faq-01.html
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
<details>
<summary>How to join The 512KB Club</summary>
<p>If you're interested in getting your site added to <b>The 512KB Club</b>, all you need to do is follow these instructions:</p>
<summary>How to join The 512KB Club</summary>
<p>If you're interested in getting your site added to <b>The 512KB Club</b>, all you need to do is follow these
instructions:</p>

<ol>
<li>Do a <a target="blank" href="https://gtmetrix.com">GTMetrix scan</a> on your website.</li>
<li>Once complete, click on the <b>Waterfall</b> tab to make sure the <b>uncompressed</b> size of your site is less than 512KB.</li>
<li>If your site satisfies this requirement, create a pull request (<a target="blank" href="https://github.com/kevquirk/512kb.club/blob/master/README.md#how-to-create-a-pr-to-add-your-site-to-the-512kb-club">instructions here</a>) to add your site.</li>
<li>I will then review you PR and merge it into main. Once merged, your site will be added to the list.</li>
</ol>
<ol>
<li>Do a <a target="blank" href="https://gtmetrix.com">GTMetrix scan</a> on your website.</li>
<li>Once complete, click on the <b>Waterfall</b> tab to make sure the <b>uncompressed</b> size of your site is
less than 512KB.</li>
<li>If your site satisfies this requirement, create a pull request (<a target="blank"
href="https://github.com/kevquirk/512kb.club/blob/master/README.md#how-to-create-a-pr-to-add-your-site-to-the-512kb-club">instructions
here</a>) to add your site.</li>
<li>I will then review you PR and merge it into main. Once merged, your site will be added to the list.</li>
</ol>

<p class="small"><b>Note:</b> <i>I reserve the right to not add sites based on whether I think they're suitable to be added or not.</i></p>
<p class="small"><b>Note:</b> <i>I reserve the right to not add sites based on whether I think they're suitable to
be added or not.</i></p>
</details>
32 changes: 19 additions & 13 deletions _includes/faq-02.html
Original file line number Diff line number Diff line change
@@ -1,23 +1,29 @@
<details>
<summary>Once you're in The 512KB Club</summary>
<p>If your site qualifies for <b>The 512KB Club</b>, I will add it to one of the following 3 teams:</p>
<summary>Once you're in The 512KB Club</summary>
<p>If your site qualifies for <b>The 512KB Club</b>, I will add it to one of the following 3 teams:</p>

<ol>
<li><b><span style="color:var(--before-green); text-shadow: 1px 1px 1px black;">The green team</span></b> is for sites with a total uncompressed size of <b>less than 100KB</b>.</li>
<li><b><span style="color:var(--before-orange); text-shadow: 1px 1px 1px black;">The orange team</span></b> is for sites with a total uncompressed size of <b>less than 250KB</b>.</li>
<li><b><span style="color:var(--before-blue); text-shadow: 1px 1px 1px black;">The blue team</span></b> is for sites with a total uncompressed size of <b>less than 512KB</b>.</li>
</ol>
<ol>
<li><b><span style="color:var(--before-green); text-shadow: 1px 1px 1px black;">The green team</span></b> is for
sites with a total uncompressed size of <b>less than 100KB</b>.</li>
<li><b><span style="color:var(--before-orange); text-shadow: 1px 1px 1px black;">The orange team</span></b> is
for sites with a total uncompressed size of <b>less than 250KB</b>.</li>
<li><b><span style="color:var(--before-blue); text-shadow: 1px 1px 1px black;">The blue team</span></b> is for
sites with a total uncompressed size of <b>less than 512KB</b>.</li>
</ol>

<p>Once you're a proud member of one of the teams, you are free to use one of the banners below on your own website. You can either save the SVG or use the code snippet below (remembering to change the name to whichever team you're in).</p>
<p>Once you're a proud member of one of the teams, you are free to use one of the banners below on your own website.
You can either save the SVG or use the code snippet below (remembering to change the name to whichever team
you're in).</p>

<p><img src="/assets/images/green-team.svg" alt="green team banner" /></p>
<p><img src="/assets/images/green-team.svg" alt="green team banner" /></p>

<p><img src="/assets/images/orange-team.svg" alt="orange team banner" /></p>
<p><img src="/assets/images/orange-team.svg" alt="orange team banner" /></p>

<p><img src="/assets/images/blue-team.svg" alt="blue team banner" /></p>
<p><img src="/assets/images/blue-team.svg" alt="blue team banner" /></p>

<pre><code>&lt;a href="https://512kb.club"&gt;&lt;img src="https://512kb.club/assets/images/green-team.svg" /&gt;&lt;/a&gt;</code></pre>
<pre><code>&lt;a href="https://512kb.club"&gt;&lt;img src="https://512kb.club/assets/images/green-team.svg" /&gt;&lt;/a&gt;</code></pre>

<p>Alternatively, you can add the banner to your site in pure HTML/CSS using <a target="blank" href="https://codepen.io/kevquirk/pen/VwmVaKm">this CodePen</a> as a guide.</p>
<p>Alternatively, you can add the banner to your site in pure HTML/CSS using <a target="blank"
href="https://codepen.io/kevquirk/pen/VwmVaKm">this CodePen</a> as a guide.</p>

</details>
9 changes: 6 additions & 3 deletions _includes/faq-03.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
<details>
<summary>I've optimised some more, what now?</summary>
<p><b>The 512KB Club</b> appears to have sparked some interest in a lot of website owners and the whole thing has become somewhat of a race to the top.</p>
<summary>I've optimised some more, what now?</summary>
<p><b>The 512KB Club</b> appears to have sparked some interest in a lot of website owners and the whole thing has
become somewhat of a race to the top.</p>

<p>If you have optimised your website further and want to change your number, please log a <b>new</b> <a target="blank" href="https://github.com/kevquirk/512kb.club/issues">GitHub issue</a> ensuring the title clearly states this is an update.</p>
<p>If you have optimised your website further and want to change your number, please log a <b>new</b> <a
target="blank" href="https://github.com/kevquirk/512kb.club/issues">GitHub issue</a> ensuring the title
clearly states this is an update.</p>
</details>
16 changes: 10 additions & 6 deletions _includes/faq-04.html
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
<details>
<summary>My site doesn't qualify, what can I do?</summary>
<p>Many sites won't qualify for the 512KB Club, but there are some quick things you could try to reduce the size of your site:</p>
<summary>My site doesn't qualify, what can I do?</summary>
<p>Many sites won't qualify for the 512KB Club, but there are some quick things you could try to reduce the size of
your site:</p>

<p><b>1. Replace custom fonts with a local font stack by replacing your <code>font-family</code> declerations in your CSS to one of the following:</b></p>
<pre><code># Sans-serif font stack
<p><b>1. Replace custom fonts with a local font stack by replacing your <code>font-family</code> declerations in
your CSS to one of the following:</b></p>
<pre><code># Sans-serif font stack
font-family: -apple-system, BlinkMacSystemFont, "Avenir Next", Avenir, "Nimbus Sans L", Roboto, Noto, "Segoe UI", Arial, Helvetica, "Helvetica Neue", sans-serif;

# Serif font stack
font-family: Constantia, "Lucida Bright", Lucidabright, "Lucida Serif", Lucida, "DejaVu Serif", "Bitstream Vera Serif", "Liberation Serif", Georgia, serif;</code></pre>

<p><b>2. Optimise any images you have on your page.</b> <a target="blank" href="https://shortpixel.com">Short Pixel</a> is a great service for this.</p>
<p><b>2. Optimise any images you have on your page.</b> <a target="blank" href="https://shortpixel.com">Short
Pixel</a> is a great service for this.</p>

<p><b>3. If all else fails</b> and your site is pretty close the 512KB, but not quite there, why not apply for Bradley Taunt's <a target="blank" href="https://1mb.club">1MB Club</a> instead?</p>
<p><b>3. If all else fails</b> and your site is pretty close the 512KB, but not quite there, why not apply for
Bradley Taunt's <a target="blank" href="https://1mb.club">1MB Club</a> instead?</p>
</details>
16 changes: 9 additions & 7 deletions _includes/faq-05.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<details>
<summary>What's the point of all this?</summary>
<p><b>That's a great question!</b></p>
<summary>What's the point of all this?</summary>
<p><b>That's a great question!</b></p>

<p>I decided to start this project for a couple of reasons:</p>
<p>I decided to start this project for a couple of reasons:</p>

<ol>
<li>Most, if not all, of the sites listed below are personal sites. Many of which are blogs. The 512KB Club is a great way of discovering other blog owners who are also interested in minimalist/efficient web design. Think of it like a modern day <a target="blank" href="https://en.wikipedia.org/wiki/Webring">webring</a>.</li>
<li>It's a bit of fun, so why not?</li>
</ol>
<ol>
<li>Most, if not all, of the sites listed below are personal sites. Many of which are blogs. The 512KB Club is a
great way of discovering other blog owners who are also interested in minimalist/efficient web design. Think
of it like a modern day <a target="blank" href="https://en.wikipedia.org/wiki/Webring">webring</a>.</li>
<li>It's a bit of fun, so why not?</li>
</ol>
</details>
8 changes: 5 additions & 3 deletions _includes/faq-06.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
<details>
<summary>I see a problem / how do I get in touch?</summary>
<p>See a problem on this site? Maybe there's a site listed that's not longer live, or no longer qualifies for the club. Or, maybe you just want to get in touch for some reason.</p>
<summary>I see a problem / how do I get in touch?</summary>
<p>See a problem on this site? Maybe there's a site listed that's not longer live, or no longer qualifies for the
club. Or, maybe you just want to get in touch for some reason.</p>

<p>If so, <a target="blank" href="https://github.com/kevquirk/512kb.club/issues">create an issue on GitHub</a> or use <a target="blank" href="https://kevq.uk/contact">the contact page on my main website</a>.</p>
<p>If so, <a target="blank" href="https://github.com/kevquirk/512kb.club/issues">create an issue on GitHub</a> or
use <a target="blank" href="https://kevq.uk/contact">the contact page on my main website</a>.</p>
</details>
19 changes: 13 additions & 6 deletions _includes/faq-07.html
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
<details>
<summary id="lightweight-notice">Notice about ultra lightweight sites</summary>
<p>There are a growing number of "sites" being submitted to The 512KB Club that are ultra lightweight (usually <1KB). These sites often contain absolutely no information apart from a couple of links to other pages that <i>do</i> contain information.</p>
<summary id="lightweight-notice">Notice about ultra lightweight sites</summary>
<p>There are a growing number of "sites" being submitted to The 512KB Club that are ultra lightweight (usually
<1KB). These sites often contain absolutely no information apart from a couple of links to other pages that <i>
do</i> contain information.</p>

<p><b>These sites are not in keeping with the aim of The 512KB Club and will not be added.</b> To be added to this site the page you submit must contain a reasonable amount of information.</p>
<p><b>These sites are not in keeping with the aim of The 512KB Club and will not be added.</b> To be added to this
site the page you submit must contain a reasonable amount of information.</p>

<p class="medium">But what qualifies as a "reasonable amount of information"?</p>
<p class="medium">But what qualifies as a "reasonable amount of information"?</p>

<p>Great question! Ultimately it's for me to decide and I will use my own discretion, but as a guide, if your site contains nothing more than a title and a couple of links, it <b>won't</b> be added. If you page contains some CSS formatting, a couple of paragraphs of text, and links to other pages, it will probably be added.</p>
<p>Great question! Ultimately it's for me to decide and I will use my own discretion, but as a guide, if your site
contains nothing more than a title and a couple of links, it <b>won't</b> be added. If you page contains some
CSS formatting, a couple of paragraphs of text, and links to other pages, it will probably be added.</p>

<p>The aim of The 512KB Club is to showcase lightweight websites. Anyone can create a website that is under 1KB, but composed only of a single <code>h1</code> tag and a couple of links. That's boring - try and be more interesting.</p>
<p>The aim of The 512KB Club is to showcase lightweight websites. Anyone can create a website that is under 1KB, but
composed only of a single <code>h1</code> tag and a couple of links. That's boring - try and be more
interesting.</p>
</details>
18 changes: 9 additions & 9 deletions _includes/green-team.html
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<ul class="green">
{% for item in site.data.green-team %}
<li>
<span class="before" style="--data-size:{{ item.size }};"></span>
<span class="after">{{ item.size }} KB</span>
<a class="site" target="blank" href="{{ item.url }}">{{ item.domain }}</a>
</li>
{% endfor %}
</ul>
<ul class="green">
{% for item in site.data.green-team %}
<li>
<span class="before" style="--data-size:{{ item.size }};"></span>
<span class="after">{{ item.size }} KB</span>
<a class="site" target="blank" href="{{ item.url }}">{{ item.domain }}</a>
</li>
{% endfor %}
</ul>
18 changes: 9 additions & 9 deletions _includes/orange-team.html
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<ul class="orange">
{% for item in site.data.orange-team %}
<li>
<span class="before" style="--data-size:{{ item.size }};"></span>
<span class="after">{{ item.size }} KB</span>
<a class="site" target="blank" href="{{ item.url }}">{{ item.domain }}</a>
</li>
{% endfor %}
</ul>
<ul class="orange">
{% for item in site.data.orange-team %}
<li>
<span class="before" style="--data-size:{{ item.size }};"></span>
<span class="after">{{ item.size }} KB</span>
<a class="site" target="blank" href="{{ item.url }}">{{ item.domain }}</a>
</li>
{% endfor %}
</ul>
76 changes: 40 additions & 36 deletions _layouts/default.html
Original file line number Diff line number Diff line change
@@ -1,36 +1,40 @@
<!doctype html>
<html lang="en-GB">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
{% seo %}
<link rel="stylesheet" href="/assets/css/style.css">
<link rel="icon" type="image/png" href="/assets/images/favicon.png" />
<!-- Plausible analytics -->
<script async defer data-domain="512kb.club" src="https://plausible.io/js/plausible.js"></script>
</head>
<body>
<a name="top"></a>

<header>
<h1>The 512KB Club</h1>
</header>

<main>

{{ content }}

</main>

<footer>

<p>The 512KB Club was created by <a href="https://kevq.uk">Kev Quirk</a> and was inspired by <a href="https://uglyduck.ca">Bradley Taunt's</a> 1MB Club.</p>

<p>Maintained with &hearts; for a performant, lightweight web.</p>

<a href="#top">^ TOP ^</a>

</footer>

</body>
</html>
<!doctype html>
<html lang="en-GB">

<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
{% seo %}
<link rel="stylesheet" href="/assets/css/style.css">
<link rel="icon" type="image/png" href="/assets/images/favicon.png" />
<!-- Plausible analytics -->
<script async defer data-domain="512kb.club" src="https://plausible.io/js/plausible.js"></script>
</head>

<body>
<a name="top"></a>

<header>
<h1>The 512KB Club</h1>
</header>

<main>

{{ content }}

</main>

<footer>

<p>The 512KB Club was created by <a href="https://kevq.uk">Kev Quirk</a> and was inspired by <a
href="https://uglyduck.ca">Bradley Taunt's</a> 1MB Club.</p>

<p>Maintained with &hearts; for a performant, lightweight web.</p>

<a href="#top">^ TOP ^</a>

</footer>

</body>

</html>
2 changes: 1 addition & 1 deletion _redirects
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
https://512kb.club/images/green-team.svg https://512kb.club/assets/images/green-team.svg
https://512kb.club/images/orange-team.svg https://512kb.club/assets/images/orange-team.svg
https://512kb.club/images/blue-team.svg https://512kb.club/assets/images/blue-team.svg
https://512kb.club/images/blue-team.svg https://512kb.club/assets/images/blue-team.svg
Loading

0 comments on commit d54e496

Please sign in to comment.