Skip to content

Commit 43767ab

Browse files
authored
Merge pull request #36 from Hyper-Unearthing/feat/improve-blog-text
feat: improve legability of blogs
2 parents 1e30a93 + 578d48c commit 43767ab

2 files changed

Lines changed: 66 additions & 25 deletions

File tree

_posts/2025-08-14-commits.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ This makes it easy to understand when looking at the history what are the exact
2828
### Tagging commits
2929

3030
By tagging it means using part of your allocated summary to encode information into your commit message. for example:
31-
- refactor: Changes the code but does not change any behaviour, no tests should be affected
32-
- fix: Changes a unintended behaviour
33-
- feat: Adds net new behaviour to the system
34-
- cicd: only updates build and tests pipelines
31+
- **refactor**: Changes the code but does not change any behaviour, no tests should be affected
32+
- **fix**: Changes a unintended behaviour
33+
- **feat**: Adds net new behaviour to the system
34+
- **cicd**: only updates build and tests pipelines
3535

3636
This makes it easy to see in the past month what kinds of activities did we perform, it also gives reviewers context what code to expect in a commit.
3737

@@ -43,26 +43,29 @@ The description of a commit message should encapsulate your thoughts around what
4343

4444
Some examples of good content for history:
4545

46-
1. How the code can be improved
47-
2. Any challenges you encountered while writing the code
48-
3. What were the reasons why you coded it this way
46+
- How the code can be improved
47+
- Any challenges you encountered while writing the code
48+
- What were the reasons why you coded it this way
4949

5050
## Consistent Format
5151

5252
Just as we apply style guides to our codebase, commits should follow a consistent format. As long as the content is meaningful, the format does not really matter. For example:
5353

54-
```
55-
summary < 50 chars
56-
description < 72 chars (per line)
57-
type of change: Enum(refact, fix, feat, cicd, burn)
5854

59-
<type of change>: <summary>
6055

61-
<description>
62-
```
56+
- summary < 50 chars
57+
- description < 72 chars (per line)
58+
- type of change: Enum(refact, fix, feat, cicd, burn)
59+
60+
> &lt;type of change&gt;: &lt;summary&gt;
61+
<br />
62+
<br />
63+
&lt;description&gt;
64+
6365

6466
Here are two examples of recent commits.
65-
```
67+
68+
{% highlight ruby %}
6669
commit 6ad486c23b634f448feecda54eb976d38c401b80
6770
Author: billybonks <sebastienstettler@gmail.com>
6871
Date: Wed Aug 13 16:16:30 2025 +0800
@@ -72,9 +75,9 @@ Date: Wed Aug 13 16:16:30 2025 +0800
7275
the css is kinda yolo and not the best can change :D!
7376
does not handle the case where you can label both elements because it
7477
requires a bunch more work. specifically how forms are made
75-
```
78+
{% endhighlight %}
7679

77-
```
80+
{% highlight ruby %}
7881
commit e341fa8b2827994af2c57bdb1e1744c134c9befe
7982
Author: billybonks <sebastienstettler@gmail.com>
8083
Date: Wed Aug 13 00:25:27 2025 +0800
@@ -83,4 +86,4 @@ Date: Wed Aug 13 00:25:27 2025 +0800
8386

8487
we will be deleting all the vega code in favour of the backend aggregation
8588
but this code is still required
86-
```
89+
{% endhighlight %}

assets/components/posts.css

Lines changed: 45 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
.post-container {
2-
display: flex;
3-
justify-content: center;
4-
padding: 20px;
2+
display: flex;
3+
justify-content: center;
4+
padding: 20px;
55
}
66

77
.post {
8-
max-width: 860px;
8+
max-width: 860px;
99
}
1010

1111
.post h1,
@@ -14,9 +14,47 @@
1414
.post h4,
1515
.post h5,
1616
.post h6 {
17-
margin-bottom: 20px;
1817
}
1918

20-
.post p {
21-
margin-bottom: 10px;
19+
.post strong {
20+
font-weight: 600;
21+
}
22+
.post p,
23+
.post ul,
24+
.post ol {
25+
margin-bottom: 20px;
26+
color: #cfcbea;
27+
}
28+
29+
.post ul {
30+
background-color: #292453;
31+
color: #8eb7e3;
32+
border-radius: 3px;
33+
padding: 10px;
34+
}
35+
36+
.post li {
37+
margin-bottom: auto;
38+
}
39+
40+
.post h1 {
41+
margin-bottom: 15px;
42+
}
43+
44+
.post h2,
45+
.post h3 {
46+
font-size: var(--h2-font-size);
47+
text-transform: none;
48+
margin: 50px 0 15px 0;
49+
}
50+
.post .highlight,
51+
.post blockquote {
52+
background-color: #1e2e5b;
53+
border-left: 10px #8ebfe3 solid;
54+
color: #8ebfe3;
55+
border-radius: 3px;
56+
padding: 20px;
57+
font-size: 17px;
58+
line-height: initial;
59+
margin-bottom: 20px;
2260
}

0 commit comments

Comments
 (0)