Skip to content

Commit 4b4c262

Browse files
reinhart1010reinhart1010
committed
feat: HAM v1.0
1 parent a06a79d commit 4b4c262

25 files changed

+670
-236
lines changed

‎README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,12 @@ external_links:
3030

3131
# HAM 🥩
3232

33+
> [!IMPORTANT]
34+
>
3335
> **BREAKING CHANGE:** HAM is currently being upgraded to Halfmoon 2.0, which introduce visual breaking changes. See <https://github.com/reinhart1010/HAM/issues/6>.
3436
37+
{% youtube 0FKaIiRhUME %}
38+
3539
HAM is a Jekyll-based boilerplate template for generating better, static wiki-style websites. HAM can be instantly used to build static wiki pages. But the best of all, the default theme of HAM can be easily customized to create more personalized wiki pages, unlike those from MediaWiki, for example.
3640

3741
This project is built to replace the current, MediaWiki installation at <hackapedia.reinhart1010.id> after I found out difficult to create custom styles for it, while other, Git-based alternatives such as GitHub Wiki sucks (no, really) and may not support self-hosting on shared hosting providers.
@@ -128,6 +132,31 @@ ham:
128132
129133
Note: You can also override the whole favicon settings (either to entirely remove, or adding mobile or browser-specific icon formats) by overriding `_includes/favicon.html`.
130134

135+
### Navigation
136+
HAM currently provides two navigation areas: the **navigation bar** and the **index** (as on the sidebar).
137+
138+
#### Navigation Bar
139+
You can freely add items in the navigation bar by modifying `_includes/navbar.html`, including placing additional nested menus, dialogs/modals, and other HTML tags.
140+
141+
#### Sidebar
142+
Just like the "On This Page" section, you can add custom sections into the sidebar. Note that the configuration is stored **outside** the `ham` section of `_config.yml` (see below example).
143+
144+
```yaml
145+
ham:
146+
# Other HAM configuration here
147+
data:
148+
index:
149+
- name: "Customise Me"
150+
id: "customize-me"
151+
children:
152+
- name: "Sample Menu 1"
153+
url: "#"
154+
- name: "Sample Menu 2"
155+
url: "#"
156+
- name: "Sample Menu 3"
157+
url: "#"
158+
```
159+
131160
### Comments
132161
HAM provides built-in support for Facebook, Giscus, Telegram, and Utteranc.es widgets plugins. However, you can also add your own widgets or links by following these instructions.
133162

‎_config.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ defaults:
66
ham:
77
site_icon: https://raw.githubusercontent.com/googlefonts/noto-emoji/main/svg/emoji_u1f969.svg
88
highlighter: rouge
9+
include:
10+
- _embed
911
kramdown:
1012
input: GFM
1113
syntax_highlighter: rouge

‎_embed/youtube.html

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<!-- Halfmoon CSS -->
5+
<link href="/assets/halfmoon-variables.min.css" rel="stylesheet" />
6+
7+
<!-- Bootstrap Icons CSS -->
8+
<link href="/assets/bootstrap-icons.min.css" rel="stylesheet" />
9+
10+
<!-- Core CSS required for HAM to work properly -->
11+
<link href="/assets/default.css" rel="stylesheet" />
12+
13+
<!-- Additional CSS -->
14+
<link href="/assets/main.css" rel="stylesheet" />
15+
<link href="/assets/syntax-highlighter.css" rel="stylesheet" />
16+
17+
<script src="/assets/cookies.js"></script>
18+
</head>
19+
<body>
20+
<div id="settings" class="alert alert-warning bg-body min-vh-100 vw-100 m-0">
21+
<p><strong class="text-warning-emphasis">This page contains an embedded video from YouTube.</strong> You can watch the video directly here, on YouTube, or on alternative viewers including <a target="_blank" href="https://invidious.io">Invidious</a> and <a a target="_blank" href="https://piped.kavin.rocks">Piped</a>.</p>
22+
<select id="yt-embed-choice" name="yt-embed-choice" class="form-select mb-1" aria-label="Choose how would you like to view this content." onchange="updateInstanceField()">
23+
<option value="yt-embed" selected>Watch video here (YouTube)</option>
24+
<option value="iv-embed">Watch video here (Invidious)</option>
25+
<option value="yt-open">Open in YouTube</option>
26+
<option value="iv-open">Open in...</option>
27+
</select>
28+
<div class="mb-1">
29+
<div class="input-group">
30+
<label for="yt-instance-url" class="input-group-text" id="yt-instance-url-label">Instance URL</label>
31+
<input type="text" class="form-control" id="yt-instance-url" aria-describedby="yt-instance-url-label" placeholder="https://youtube.com" required>
32+
</div>
33+
<div class="form-text">The instance must be accessible under HTTPS.</div>
34+
</div>
35+
<div class="d-flex align-items-center gap-2">
36+
<button class="btn btn-warning" onclick="openButton()">Open</button>
37+
<div class="form-check">
38+
<input class="form-check-input" type="checkbox" id="yt-embed-save-preferences">
39+
<label class="form-check-label" for="yt-embed-save-preferences">
40+
Apply to all (requires reload)
41+
</label>
42+
</div>
43+
</div>
44+
</div>
45+
<div id="redirect" class="d-none alert alert-warning bg-body min-vh-100 vw-100 m-0 d-flex flex-column align-items-center justify-content-center">
46+
<p id="redirect-text"></p>
47+
<button class="btn btn-warning" onclick="cancelButton()">Change Settings</button>
48+
</div>
49+
<!-- Bootstrap JS for color modes -->
50+
<script src="/assets/bootstrap-color-modes.js"></script>
51+
<script>
52+
const searchParams = new URLSearchParams(window.location.search);
53+
const videoId = searchParams.get("id");
54+
let redirectTimer = null;
55+
56+
function initFields() {
57+
const embedPreferenceEl = document.getElementById("yt-embed-choice");
58+
const instanceUrlEl = document.getElementById("yt-instance-url");
59+
const savePreferencesEl = document.getElementById("yt-embed-save-preferences");
60+
61+
embedPreferenceEl.value = getCookie("_ham_embed_yt_preference") ?? "yt-embed";
62+
instanceUrlEl.value = getCookie("_ham_embed_yt_instance") ?? "https://youtube.com";
63+
}
64+
65+
function updateInstanceField() {
66+
const embedPreferenceEl = document.getElementById("yt-embed-choice");
67+
const instanceUrlEl = document.getElementById("yt-instance-url");
68+
if (embedPreferenceEl.value.startsWith("yt-")) {
69+
instanceUrlEl.disabled = true;
70+
instanceUrlEl.value = "https://youtube.com";
71+
} else {
72+
instanceUrlEl.disabled = false;
73+
instanceUrlEl.value = "";
74+
}
75+
}
76+
77+
function openButton() {
78+
const embedPreferenceEl = document.getElementById("yt-embed-choice");
79+
const instanceUrlEl = document.getElementById("yt-instance-url");
80+
const savePreferencesEl = document.getElementById("yt-embed-save-preferences");
81+
82+
instanceUrlEl.value.replace(/^(http(s){0,1}):\/\//, "https://")
83+
84+
if (savePreferencesEl.value == "on") {
85+
setCookie("_ham_embed_yt_preference", embedPreferenceEl.value, 30);
86+
setCookie("_ham_embed_yt_instance", instanceUrlEl.value, 30);
87+
window.location.reload();
88+
}
89+
redirect(embedPreferenceEl.value, instanceUrlEl.value, true);
90+
}
91+
92+
// Check whether the user has saved preferences.
93+
const preference = getCookie("_ham_embed_yt_preference");
94+
const instance = getCookie("_ham_embed_yt_instance");
95+
const redirectContainerEl = document.getElementById("redirect");
96+
const settingsContainerEl = document.getElementById("settings");
97+
const redirectTextEl = document.getElementById("redirect-text");
98+
99+
function cancelButton() {
100+
if (redirectTimer) clearTimeout(redirectTimer);
101+
redirectContainerEl.classList.add("d-none");
102+
settingsContainerEl.classList.remove("d-none");
103+
}
104+
105+
function redirect(preference, instance, force) {
106+
if (preference && instance) {
107+
redirectContainerEl.classList.remove("d-none");
108+
settingsContainerEl.classList.add("d-none");
109+
if (preference.endsWith("-embed")) {
110+
redirectTextEl.innerHTML = "Redirecting to <a id=\"redirect-url\" class=\"text-break\"></a>…";
111+
const redirectUrlEl = document.getElementById("redirect-url");
112+
if (preference.startsWith("yt-")) {
113+
redirectUrlEl.innerHTML = redirectUrlEl.href = "https://youtube.com/embed/" + videoId;
114+
} else {
115+
redirectUrlEl.innerHTML = redirectUrlEl.href = "https://" + instance + "/embed/" + videoId;
116+
}
117+
redirectTimer = setTimeout(() => {
118+
redirectTimer = null;
119+
if (preference.startsWith("yt-")) {
120+
window.location = "https://youtube.com/embed/" + videoId;
121+
} else {
122+
window.location = "https://" + instance + "/embed/" + videoId;
123+
}
124+
}, force ? 0 : 3000);
125+
} else {
126+
redirectTextEl.innerHTML = "Video content from <a id=\"redirect-url\" class=\"text-break\"></a>";
127+
const redirectUrlEl = document.getElementById("redirect-url");
128+
if (preference.startsWith("yt-")) {
129+
redirectUrlEl.innerHTML = redirectUrlEl.href = "https://youtube.com/watch?v=" + videoId;
130+
} else {
131+
redirectUrlEl.innerHTML = redirectUrlEl.href = "https://" + instance + "/watch?v=" + videoId;
132+
}
133+
}
134+
}
135+
}
136+
137+
redirect(preference, instance, false);
138+
initFields();
139+
updateInstanceField();
140+
</script>
141+
</body>
142+
</html>

‎_includes/comments.html

Lines changed: 4 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,4 @@
1-
{% assign contributing = page.contributing | default: site.ham.contributing %}
2-
{% if contributing != null %}
3-
{% if contributing.discuss.type != 'url' %}
4-
<h5 id="discuss" class="sidebar-title">Discuss this page</h5>
5-
<div class="sidebar-title">
6-
{% case contributing.discuss.type %}
7-
{% when 'custom' %}
8-
{% include custom-comments.html %}
9-
{% when 'commentbox.io %}
10-
<div class="commentbox"></div>
11-
<script src="https://unpkg.com/commentbox.io/dist/commentBox.min.js"></script>
12-
<script>commentBox("{{ page.project_id }}")</script>
13-
{% when 'disqus' %}
14-
<div id="disqus_thread"></div>
15-
<script>
16-
var disqus_config = function () {
17-
this.page.url = "{{ page.url }}";
18-
this.page.identifier = "{{ page.url }}";
19-
};
20-
(function() {
21-
var d = document, s = d.createElement('script');
22-
s.src = 'https://{{ contributing.discuss.forum_shortname }}.disqus.com/embed.js';
23-
s.setAttribute('data-timestamp', +new Date());
24-
(d.head || d.body).appendChild(s);
25-
})();
26-
</script>
27-
{% when 'facebook' %}
28-
{% if contributing.discuss.facebook_app_id != null %}
29-
<div id="fb-root"></div>
30-
<script async defer crossorigin="anonymous" src="https://connect.facebook.net/{{ contributing.discuss.lang }}/sdk.js#xfbml=1&version=v17.0&appId={{ contributing.discuss.facebook_app_id }}&autoLogAppEvents=1" nonce="mqsBinib"></script>
31-
<div class="fb-comments" data-href="https://developers.facebook.com/docs/plugins/comments#configurator" data-width="" data-numposts="5"></div>
32-
{% endif %}
33-
{% when 'giscus' %}
34-
<script src="https://giscus.app/client.js" data-repo="{{ contributing.discuss.repo }}" data-repo-id="{{ contributing.discuss.repo_id }}" data-category="{{ contributing.discuss.category }}" data-category-id="{{ contributing.discuss.category_id }}" data-mapping="{{ contributing.discuss.mapping }}" data-reactions-enabled="{{ contributing.discuss.reactions_enabled | default: 1 }}" data-emit-metadata="{{ contributing.discuss.emit_metadata | default: 0 }}" data-theme="{{ contributing.discuss.theme | default: 'preferred_color_scheme' }}" data-lang="{{ contributing.discuss.lang | default: 'en' }}" crossorigin="anonymous" async></script>
35-
{% when 'telegram' %}
36-
<script src="https://telegram.org/js/telegram-widget.js?15" {% if contributing.discuss.telegram_discussion != null %} data-telegram-discussion="{{ contributing.discuss.telegram_discussion }}" {% endif %} data-comments-limit="{{ contributing.discuss.comments_limit | default: '5' }}" {% if contributing.discuss.height != null %} data-height="{{ contributing.discuss.height }}" {% endif %} data-color="{{ contributing.discuss.color | default: '319BE6' }}" data-dark-color="{{ contributing.discuss.color | default: '4BA3E2' }}" data-colorful="{{ contributing.discuss.colorful | default: 0 }}" data-dark="{{ contributing.discuss.dark | default: 0 }}" crossorigin="anonymous" async></script>
37-
{% when 'utterances' %}
38-
<script src="https://utteranc.es/client.js" repo="{{ contributing.discuss.repo }}" issue-term="{{ contributing.discuss.issue_term }}"
39-
{% if contributing.discuss.label != null %}
40-
label="{{ contributing.discuss.label }}"
41-
{% endif %}
42-
theme="{{ contributing.discuss.theme | default: 'preferred-color-scheme' }}" crossorigin="anonymous" async></script>
43-
{% endcase %}
44-
<noscript>
45-
Please enable JavaScript to view comments and discussions
46-
</noscript>
47-
</div>
48-
{% endif %}
49-
{% endif %}
1+
<div class="alert alert-danger" role="alert">
2+
<h4 class="alert-heading">Error: Custom comment widget is not set up.</h4>
3+
Make sure that the custom comment widget code is placed under <code>/_includes/custom-comments.html</code>, then recompile.
4+
</div>

‎_includes/custom-comments.html

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎_includes/ham/comments.html

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
{% assign contributing = page.contributing | default: site.ham.contributing %}
2+
{% if contributing != null %}
3+
{% if contributing.discuss.type != 'url' %}
4+
<h5 id="discuss" class="sidebar-title">Discuss this page</h5>
5+
<div class="sidebar-title">
6+
{% case contributing.discuss.type %}
7+
{% when 'custom' %}
8+
{% include comments.html %}
9+
{% when 'commentbox.io %}
10+
<div class="commentbox"></div>
11+
<script src="https://unpkg.com/commentbox.io/dist/commentBox.min.js"></script>
12+
<script>commentBox("{{ page.project_id }}")</script>
13+
{% when 'disqus' %}
14+
<div id="disqus_thread"></div>
15+
<script>
16+
var disqus_config = function () {
17+
this.page.url = "{{ page.url }}";
18+
this.page.identifier = "{{ page.url }}";
19+
};
20+
(function() {
21+
var d = document, s = d.createElement('script');
22+
s.src = 'https://{{ contributing.discuss.forum_shortname }}.disqus.com/embed.js';
23+
s.setAttribute('data-timestamp', +new Date());
24+
(d.head || d.body).appendChild(s);
25+
})();
26+
</script>
27+
{% when 'facebook' %}
28+
{% if contributing.discuss.facebook_app_id != null %}
29+
<div id="fb-root"></div>
30+
<script async defer crossorigin="anonymous" src="https://connect.facebook.net/{{ contributing.discuss.lang }}/sdk.js#xfbml=1&version=v17.0&appId={{ contributing.discuss.facebook_app_id }}&autoLogAppEvents=1" nonce="mqsBinib"></script>
31+
<div class="fb-comments" data-href="https://developers.facebook.com/docs/plugins/comments#configurator" data-width="" data-numposts="5"></div>
32+
{% endif %}
33+
{% when 'giscus' %}
34+
<script src="https://giscus.app/client.js" data-repo="{{ contributing.discuss.repo }}" data-repo-id="{{ contributing.discuss.repo_id }}" data-category="{{ contributing.discuss.category }}" data-category-id="{{ contributing.discuss.category_id }}" data-mapping="{{ contributing.discuss.mapping }}" data-reactions-enabled="{{ contributing.discuss.reactions_enabled | default: 1 }}" data-emit-metadata="{{ contributing.discuss.emit_metadata | default: 0 }}" data-theme="{{ contributing.discuss.theme | default: 'preferred_color_scheme' }}" data-lang="{{ contributing.discuss.lang | default: 'en' }}" crossorigin="anonymous" async></script>
35+
{% when 'telegram' %}
36+
<script src="https://telegram.org/js/telegram-widget.js?15" {% if contributing.discuss.telegram_discussion != null %} data-telegram-discussion="{{ contributing.discuss.telegram_discussion }}" {% endif %} data-comments-limit="{{ contributing.discuss.comments_limit | default: '5' }}" {% if contributing.discuss.height != null %} data-height="{{ contributing.discuss.height }}" {% endif %} data-color="{{ contributing.discuss.color | default: '319BE6' }}" data-dark-color="{{ contributing.discuss.color | default: '4BA3E2' }}" data-colorful="{{ contributing.discuss.colorful | default: 0 }}" data-dark="{{ contributing.discuss.dark | default: 0 }}" crossorigin="anonymous" async></script>
37+
{% when 'utterances' %}
38+
<script src="https://utteranc.es/client.js" repo="{{ contributing.discuss.repo }}" issue-term="{{ contributing.discuss.issue_term }}"
39+
{% if contributing.discuss.label != null %}
40+
label="{{ contributing.discuss.label }}"
41+
{% endif %}
42+
theme="{{ contributing.discuss.theme | default: 'preferred-color-scheme' }}" crossorigin="anonymous" async></script>
43+
{% endcase %}
44+
<noscript>
45+
Please enable JavaScript to view comments and discussions
46+
</noscript>
47+
</div>
48+
{% endif %}
49+
{% endif %}

‎_includes/external-link.html renamed to ‎_includes/ham/external-link.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<a href="{{ link.url }}" class="sidebar-link sidebar-link-with-icon" target="{{ link.target }}">
1+
<a href="{{ link.url }}" class="list-group-item list-group-item-action" target="{{ link.target }}">
22
<span class="sidebar-icon">
33
<i class="{{ link.icon | default: 'bi bi-file-text' }}" aria-hidden="true"></i>
44
</span>

‎_includes/footer.html renamed to ‎_includes/ham/footer.html

File renamed without changes.

‎_includes/ham/navbar.html

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<nav class="navbar navbar-expand-lg sticky-top" style="background-color: var(--bs-content-bg); border-bottom: var(--bs-border-width) solid var(--bs-content-border-color);">
2+
<div class="container-fluid">
3+
<div class="btn-group d-md-none" role="group">
4+
<button type="button" data-bs-toggle="offcanvas" data-bs-target="#_ham_sidebar" aria-controls="_ham_sidebar" class="btn btn-secondary">
5+
<i class="bi bi-search" aria-hidden="true"></i>
6+
</button>
7+
<button type="button" data-bs-toggle="offcanvas" data-bs-target="#_ham_sidebar" aria-controls="_ham_sidebar" class="btn btn-secondary">
8+
<i class="bi bi-list-nested me-1" aria-hidden="true"></i> Menu
9+
</button>
10+
</div>
11+
<a class="navbar-brand" href="#">
12+
{% if site.ham.site_icon != null %}
13+
<img src="{{ site.ham.site_icon }}" alt="{{ site.title }}" width="24" height="24" class="d-inline-block align-text-top">
14+
{% endif %}{{ site.title }}
15+
</a>
16+
<div class="btn-group d-md-none" role="group">
17+
<button type="button" data-bs-toggle="collapse" data-bs-target="#_ham_settings" aria-controls="_ham_settings" class="btn btn-secondary">
18+
<i class="bi bi-gear me-1" aria-hidden="true"></i>
19+
<p>Settings</p>
20+
</button>
21+
</div>
22+
<div class="collapse navbar-collapse" id="_ham_settings">
23+
{% if site.tagline != null %}
24+
<span>{{ site.tagline }}</span>
25+
{% endif %}
26+
{% include navbar.html %}
27+
</div>
28+
</div>
29+
</nav>

‎_includes/random-posts.html renamed to ‎_includes/ham/random-posts.html

File renamed without changes.

‎_includes/search-modal.html renamed to ‎_includes/ham/search-modal.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<span aria-hidden="true">&times;</span>
66
</a>
77
<input id="search-input" type="text" class="form-control" placeholder="Keyword">
8-
<ul id="results-container" class="my-10"></ul>
8+
<ul id="_ham_search_results_container" class="my-10"></ul>
99
<span>Search articles on this site...</span>
1010
</div>
1111
</div>

0 commit comments

Comments
 (0)