Improved: Macros, docs, templates

.github/workflows/deploy.yaml

@@ -8,8 +8,11 @@ on:
   workflow_dispatch:
 
 env:
+  # Build directory where the website will run its build. Use the dot (period) to use current.
+  builddir: .
   # Output directory where built files will deploy. This also will be used on Pagefind search generation.
   outdir: HTML
+
 defaults:
   run:
     shell: bash
@@ -24,9 +27,9 @@ jobs:
       - name: Install
         uses: taiki-e/install-action@zola
       - name: Install Python Requirements
-        run: pip install -r requirements.txt
+        run: pip install pagefind[extended]
       - name: Build
-        run: zola build
+        run: zola -r "${{ env.builddir }}" build
       # Ignore below name if you do not use pagefind.
       - name: Generate Pagefind Search
         run: python -m pagefind --site ${{ env.outdir }}

README.md

@@ -35,7 +35,7 @@ git clone https://github.com/harrymkt/zluinav.git
 ```
 Or [download manually](https://github.com/harrymkt/zluinav/archive/refs/heads/main.zip) and paste in the themes directory.
 
-Or, add to the Git submodule
+Or, add to the Git submodule (recommended):
 ```bash
 git submodule add --name zluinav https://github.com/harrymkt/zluinav.git themes/zluinav
 git submodule update --remote

content/_index.md

@@ -1,6 +1,5 @@
 +++
 title = "Home"
-insert_anchor_links = "heading"
 +++
 # UI Navigation
 UI Navigation, or known as zluinav, is a Zola theme designed for accessibility rather than visual and made as easy as possible using templates and macros. Since I am a blind developer, I'd like to develop with accessibility as possible so visually impaired users can use them.

content/_index.my.md

@@ -1,6 +1,5 @@
 +++
 title = "အိမ်"
-insert_anchor_links = "heading"
 +++
 # UI လမ်းညွှန်
 UI Navigation (သို့) zluinav ဟုခေါ်သော Zola theme သည် ပုံသဏ္ဍာန်များနှင့် မက်ခရိုများကို အသုံးပြု၍ တတ်နိုင်သမျှ လွယ်ကူအောင် ပြုလုပ်ထားခြင်းထက် အလွယ်တကူ ဖန်တီးထားသည့် Zola အပြင်အဆင်တစ်ခုဖြစ်သည်။ ကျွန်ုပ်သည် မျက်မမြင် developer တစ်ဦးဖြစ်သောကြောင့် အမြင်အာရုံချို့တဲ့သောအသုံးပြုသူများသည် ၎င်းတို့ကိုအသုံးပြုနိုင်စေရန် တတ်နိုင်သမျှ သုံးစွဲနိုင်မှုဖြင့် ဖွံ့ဖြိုးတိုးတက်စေလိုပါသည်။

content/docs/macros/general.md

@@ -6,4 +6,6 @@ General macros added in general namespace
 
 ## title(titles)
 Returns the titles, separated by the value set in `config.extra.title_sep`, with the site title appended after it.
-- `titles`(array) required: array of titles.
+- `titles`(array) required: array of titles.
+- `sep`(string) optional: The title's separator. Defaults to what it is set in `title_sep` site extra. Passing this string empty will set back to default.
+- `overwrite`(bool) optional: `false` if the site title should be appended after the titles, or `true` otherwise. Defaults to `false`.

content/docs/search.md

@@ -12,15 +12,15 @@ See [search configuration](@/docs/extra/config.md#searching)
 You have a variety of formats to choose for your search.
 
 ### main
-This format uses the default searching method configured in search according to Zola's documentation. `search.js` in the static folder provides for `elasticlunr`.
+This format uses the default searching method configured in search according to Zola's documentation. `search.js` in the static folder provides for `elasticlunr`. The only disadvantage of this search format is that custom languages cannot be used to index.
 
 ### pagefind
 This is the default used in Zluinav's demo and is a third party searching tool, and thus it cannot be used in `zola serve`. Instead, this is best if you run this tool after the build. In short, this tool runs over your HTML files to generate the search, and it only takes up a few seconds.
 
 {% details(summary="Setup Pagefind") %}
 #### Setup Pagefind
 Do the following to get up and run Pagefind. We'll asume you have Python installed:
-1. Install Pagefind extended version. You can do this by this command up to the root of this repository. `pip install -r requirements.txt`
+1. Install Pagefind extended version. You can do this by this command. `pip install -r pagefind[extended]`
 2. Set the search format in the `searching` object.
 3. Build the site. `zola build`
 4. Generate the search index. Make sure to replace outputdir with the directory where your built files live. `python -m pagefind --site outputdir`

static/scripts/search.js

@@ -143,7 +143,7 @@ function initSearch() {
 	};
 	var currentTerm = "";
 	var index;
-	const base_url = document.querySelector("base").href;
+	const base_url = document.querySelector("baseurl").href;
 	const lang = document.querySelector("html").lang;
 	const language = (lang ? lang : "en");
 	const resource_path = new URL(`search_index.${language}.json`, base_url).href;

templates/base.html

@@ -20,7 +20,7 @@
 <!doctype html>
 <html lang="{{ lang }}">
 <head>
-<base href="{{ get_url(path = "", lang = lang) }}"/>
+<baseurl href="{{ get_url(path = "", lang = lang) }}"/>
 {%- block extrahead %}
 <meta charset="UTF-8">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">

templates/mcs/general.html

@@ -1,6 +1,11 @@
-{%- macro title(titles) %}
-  {%- set titles = titles | concat(with = config.title) %}
-  {{- titles | join(sep = config.extra.title_sep) }}
+{%- macro title(titles, sep="", overwrite=false) %}
+  {%- if not sep or sep == "" %}
+    {%- set sep = config.extra.title_sep %}
+  {%- endif %}
+  {%- if not overwrite %}
+    {%- set titles = titles | concat(with = config.title) %}
+  {%- endif %}
+  {{- titles | join(sep = sep) }}
 {%- endmacro title %}
 {%- macro get_nav_attributes(attributes) %}
   {%- set navattr = "" %}

templates/taxonomy_single.html

@@ -4,9 +4,7 @@
 {%- endblock title %}
 {%- block content %}
 <h1>{{ term.name }}</h1>
-<ul>
 {%- for page in term.pages %}
-<li><a href="{{ page.permalink }}">{{ page.title }}</a></li>
+{{- postmc::post_preview(post=page, tr=tr) }}
 {%- endfor %}
-</ul>
 {%- endblock content %}