Update readme

simkianseng · Feb 26, 2024 · 8886b5f · 8886b5f
1 parent 24ce790
commit 8886b5f
Show file tree

Hide file tree

Showing 37 changed files with 2,014 additions and 40 deletions.
diff --git a/.gitignore b/.gitignore
@@ -18,3 +18,5 @@ text-cli-test/EXPECTED-UNIX.TXT
 
 # Data files
 /data/
+
+/docs/vendor
diff --git a/docs/.bundle/config b/docs/.bundle/config
@@ -0,0 +1,4 @@
+---
+BUNDLE_DEPLOYMENT: "true"
+BUNDLE_PATH: "vendor/bundle"
+BUNDLE_FROZEN: "0"
diff --git a/docs/_includes/custom-head.html b/docs/_includes/custom-head.html
@@ -0,0 +1,6 @@
+{% comment %}
+  Placeholder to allow defining custom head, in principle, you can add anything here, e.g. favicons:
+
+  1. Head over to https://realfavicongenerator.net/ to add your own favicons.
+  2. Customize default _includes/custom-head.html in your source directory and insert the given code snippet.
+{% endcomment %}
diff --git a/docs/_includes/head.html b/docs/_includes/head.html
@@ -0,0 +1,12 @@
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
+  <link rel="stylesheet" href="{{ "/assets/css/style.css" | relative_url }}">
+
+  {%- include custom-head.html -%}
+
+  <title>{{page.title}}</title>
+
+</head>
diff --git a/docs/_includes/header.html b/docs/_includes/header.html
@@ -0,0 +1,36 @@
+<header class="site-header">
+
+  <div class="wrapper">
+    {%- assign default_paths = site.pages | map: "path" -%}
+    {%- assign page_paths = site.header_pages | default: default_paths -%}
+    {%- assign titles_size = site.pages | map: 'title' | join: '' | size -%}
+    <a class="site-title" rel="author" href="{{ "/" | relative_url }}">{{ site.title | escape }}</a>
+
+    {%- if titles_size > 0 -%}
+      <nav class="site-nav">
+        <input type="checkbox" id="nav-trigger" class="nav-trigger" />
+        <label for="nav-trigger">
+          <span class="menu-icon">
+            <svg viewBox="0 0 18 15" width="18px" height="15px">
+              <path d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0 h15.032C17.335,0,18,0.665,18,1.484L18,1.484z M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.032C17.335,6.031,18,6.696,18,7.516L18,7.516z M18,13.516C18,14.335,17.335,15,16.516,15H1.484 C0.665,15,0,14.335,0,13.516l0,0c0-0.82,0.665-1.483,1.484-1.483h15.032C17.335,12.031,18,12.695,18,13.516L18,13.516z"/>
+            </svg>
+          </span>
+        </label>
+
+        <div class="trigger">
+          {%- for path in page_paths -%}
+            {%- assign my_page = site.pages | where: "path", path | first -%}
+            {%- if my_page.title -%}
+            <a class="page-link" href="{{ my_page.url | relative_url }}">{{ my_page.title | escape }}</a>
+            {%- endif -%}
+          {%- endfor -%}
+          {%- if site.repository -%}
+          <a class="page-link no-hover" href="https://github.com/{{site.repository}}">
+            <img src="{{site.github_icon | relative_url}}" class="icon" alt="View on GitHub">
+          </a>
+          {%- endif -%}
+        </div>
+      </nav>
+    {%- endif -%}
+  </div>
+</header>
diff --git a/docs/_layouts/alt-page.html b/docs/_layouts/alt-page.html
@@ -0,0 +1,14 @@
+---
+layout: default
+---
+<article class="post">
+
+  <header class="post-header">
+    <h1 class="post-title">{{ page.alt_title | escape }}</h1>
+  </header>
+
+  <div class="post-content">
+    {{ content }}
+  </div>
+
+</article>
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html lang="{{ page.lang | default: site.lang | default: "en" }}">
+
+  {%- include head.html -%}
+
+  <body>
+
+    {%- include header.html -%}
+
+    <main class="page-content" aria-label="Content">
+      <div class="wrapper">
+        {{ content }}
+      </div>
+    </main>
+
+  </body>
+
+</html>
diff --git a/docs/_layouts/page.html b/docs/_layouts/page.html
@@ -0,0 +1,14 @@
+---
+layout: default
+---
+<article class="post">
+
+  <header class="post-header">
+    <h1 class="post-title">{{ page.title | escape }}</h1>
+  </header>
+
+  <div class="post-content">
+    {{ content }}
+  </div>
+
+</article>