653 lines
41 KiB
HTML
653 lines
41 KiB
HTML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
|
<head>
|
|
<!-- 2025-08-10 Sun 18:15 -->
|
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
<title>Setup</title>
|
|
<meta name="generator" content="Org Mode" />
|
|
<style type="text/css">
|
|
#content { max-width: 60em; margin: auto; }
|
|
.title { text-align: center;
|
|
margin-bottom: .2em; }
|
|
.subtitle { text-align: center;
|
|
font-size: medium;
|
|
font-weight: bold;
|
|
margin-top:0; }
|
|
.todo { font-family: monospace; color: red; }
|
|
.done { font-family: monospace; color: green; }
|
|
.priority { font-family: monospace; color: orange; }
|
|
.tag { background-color: #eee; font-family: monospace;
|
|
padding: 2px; font-size: 80%; font-weight: normal; }
|
|
.timestamp { color: #bebebe; }
|
|
.timestamp-kwd { color: #5f9ea0; }
|
|
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
|
|
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
|
|
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
|
|
.underline { text-decoration: underline; }
|
|
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
|
|
p.verse { margin-left: 3%; }
|
|
pre {
|
|
border: 1px solid #e6e6e6;
|
|
border-radius: 3px;
|
|
background-color: #f2f2f2;
|
|
padding: 8pt;
|
|
font-family: monospace;
|
|
overflow: auto;
|
|
margin: 1.2em;
|
|
}
|
|
pre.src {
|
|
position: relative;
|
|
overflow: auto;
|
|
}
|
|
pre.src:before {
|
|
display: none;
|
|
position: absolute;
|
|
top: -8px;
|
|
right: 12px;
|
|
padding: 3px;
|
|
color: #555;
|
|
background-color: #f2f2f299;
|
|
}
|
|
pre.src:hover:before { display: inline; margin-top: 14px;}
|
|
/* Languages per Org manual */
|
|
pre.src-asymptote:before { content: 'Asymptote'; }
|
|
pre.src-awk:before { content: 'Awk'; }
|
|
pre.src-authinfo::before { content: 'Authinfo'; }
|
|
pre.src-C:before { content: 'C'; }
|
|
/* pre.src-C++ doesn't work in CSS */
|
|
pre.src-clojure:before { content: 'Clojure'; }
|
|
pre.src-css:before { content: 'CSS'; }
|
|
pre.src-D:before { content: 'D'; }
|
|
pre.src-ditaa:before { content: 'ditaa'; }
|
|
pre.src-dot:before { content: 'Graphviz'; }
|
|
pre.src-calc:before { content: 'Emacs Calc'; }
|
|
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
|
|
pre.src-fortran:before { content: 'Fortran'; }
|
|
pre.src-gnuplot:before { content: 'gnuplot'; }
|
|
pre.src-haskell:before { content: 'Haskell'; }
|
|
pre.src-hledger:before { content: 'hledger'; }
|
|
pre.src-java:before { content: 'Java'; }
|
|
pre.src-js:before { content: 'Javascript'; }
|
|
pre.src-latex:before { content: 'LaTeX'; }
|
|
pre.src-ledger:before { content: 'Ledger'; }
|
|
pre.src-lisp:before { content: 'Lisp'; }
|
|
pre.src-lilypond:before { content: 'Lilypond'; }
|
|
pre.src-lua:before { content: 'Lua'; }
|
|
pre.src-matlab:before { content: 'MATLAB'; }
|
|
pre.src-mscgen:before { content: 'Mscgen'; }
|
|
pre.src-ocaml:before { content: 'Objective Caml'; }
|
|
pre.src-octave:before { content: 'Octave'; }
|
|
pre.src-org:before { content: 'Org mode'; }
|
|
pre.src-oz:before { content: 'OZ'; }
|
|
pre.src-plantuml:before { content: 'Plantuml'; }
|
|
pre.src-processing:before { content: 'Processing.js'; }
|
|
pre.src-python:before { content: 'Python'; }
|
|
pre.src-R:before { content: 'R'; }
|
|
pre.src-ruby:before { content: 'Ruby'; }
|
|
pre.src-sass:before { content: 'Sass'; }
|
|
pre.src-scheme:before { content: 'Scheme'; }
|
|
pre.src-screen:before { content: 'Gnu Screen'; }
|
|
pre.src-sed:before { content: 'Sed'; }
|
|
pre.src-sh:before { content: 'shell'; }
|
|
pre.src-sql:before { content: 'SQL'; }
|
|
pre.src-sqlite:before { content: 'SQLite'; }
|
|
/* additional languages in org.el's org-babel-load-languages alist */
|
|
pre.src-forth:before { content: 'Forth'; }
|
|
pre.src-io:before { content: 'IO'; }
|
|
pre.src-J:before { content: 'J'; }
|
|
pre.src-makefile:before { content: 'Makefile'; }
|
|
pre.src-maxima:before { content: 'Maxima'; }
|
|
pre.src-perl:before { content: 'Perl'; }
|
|
pre.src-picolisp:before { content: 'Pico Lisp'; }
|
|
pre.src-scala:before { content: 'Scala'; }
|
|
pre.src-shell:before { content: 'Shell Script'; }
|
|
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
|
|
/* additional language identifiers per "defun org-babel-execute"
|
|
in ob-*.el */
|
|
pre.src-cpp:before { content: 'C++'; }
|
|
pre.src-abc:before { content: 'ABC'; }
|
|
pre.src-coq:before { content: 'Coq'; }
|
|
pre.src-groovy:before { content: 'Groovy'; }
|
|
/* additional language identifiers from org-babel-shell-names in
|
|
ob-shell.el: ob-shell is the only babel language using a lambda to put
|
|
the execution function name together. */
|
|
pre.src-bash:before { content: 'bash'; }
|
|
pre.src-csh:before { content: 'csh'; }
|
|
pre.src-ash:before { content: 'ash'; }
|
|
pre.src-dash:before { content: 'dash'; }
|
|
pre.src-ksh:before { content: 'ksh'; }
|
|
pre.src-mksh:before { content: 'mksh'; }
|
|
pre.src-posh:before { content: 'posh'; }
|
|
/* Additional Emacs modes also supported by the LaTeX listings package */
|
|
pre.src-ada:before { content: 'Ada'; }
|
|
pre.src-asm:before { content: 'Assembler'; }
|
|
pre.src-caml:before { content: 'Caml'; }
|
|
pre.src-delphi:before { content: 'Delphi'; }
|
|
pre.src-html:before { content: 'HTML'; }
|
|
pre.src-idl:before { content: 'IDL'; }
|
|
pre.src-mercury:before { content: 'Mercury'; }
|
|
pre.src-metapost:before { content: 'MetaPost'; }
|
|
pre.src-modula-2:before { content: 'Modula-2'; }
|
|
pre.src-pascal:before { content: 'Pascal'; }
|
|
pre.src-ps:before { content: 'PostScript'; }
|
|
pre.src-prolog:before { content: 'Prolog'; }
|
|
pre.src-simula:before { content: 'Simula'; }
|
|
pre.src-tcl:before { content: 'tcl'; }
|
|
pre.src-tex:before { content: 'TeX'; }
|
|
pre.src-plain-tex:before { content: 'Plain TeX'; }
|
|
pre.src-verilog:before { content: 'Verilog'; }
|
|
pre.src-vhdl:before { content: 'VHDL'; }
|
|
pre.src-xml:before { content: 'XML'; }
|
|
pre.src-nxml:before { content: 'XML'; }
|
|
/* add a generic configuration mode; LaTeX export needs an additional
|
|
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
|
|
pre.src-conf:before { content: 'Configuration File'; }
|
|
|
|
table { border-collapse:collapse; }
|
|
caption.t-above { caption-side: top; }
|
|
caption.t-bottom { caption-side: bottom; }
|
|
td, th { vertical-align:top; }
|
|
th.org-right { text-align: center; }
|
|
th.org-left { text-align: center; }
|
|
th.org-center { text-align: center; }
|
|
td.org-right { text-align: right; }
|
|
td.org-left { text-align: left; }
|
|
td.org-center { text-align: center; }
|
|
dt { font-weight: bold; }
|
|
.footpara { display: inline; }
|
|
.footdef { margin-bottom: 1em; }
|
|
.figure { padding: 1em; }
|
|
.figure p { text-align: center; }
|
|
.equation-container {
|
|
display: table;
|
|
text-align: center;
|
|
width: 100%;
|
|
}
|
|
.equation {
|
|
vertical-align: middle;
|
|
}
|
|
.equation-label {
|
|
display: table-cell;
|
|
text-align: right;
|
|
vertical-align: middle;
|
|
}
|
|
.inlinetask {
|
|
padding: 10px;
|
|
border: 2px solid gray;
|
|
margin: 10px;
|
|
background: #ffffcc;
|
|
}
|
|
#org-div-home-and-up
|
|
{ text-align: right; font-size: 70%; white-space: nowrap; }
|
|
textarea { overflow-x: auto; }
|
|
.linenr { font-size: smaller }
|
|
.code-highlighted { background-color: #ffff00; }
|
|
.org-info-js_info-navigation { border-style: none; }
|
|
#org-info-js_console-label
|
|
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
|
|
.org-info-js_search-highlight
|
|
{ background-color: #ffff00; color: #000000; font-weight: bold; }
|
|
.org-svg { }
|
|
</style>
|
|
|
|
<link rel="stylesheet" href="/assets/styles/style.css" />
|
|
<script src="/assets/scripts/script.js" defer></script>
|
|
</head>
|
|
<body>
|
|
<div id="preamble" class="status">
|
|
|
|
<div class="banner-header">
|
|
<a href="/"> <img src="/assets/images/gr.png" alt="Site Logo" class="banner-logo" /> </a>
|
|
<nav>
|
|
<a href="/">Home | </a>
|
|
<a href="/posts/posts-list.html">Posts | </a>
|
|
<a href="/blogs/blogs-list.html">Blogs | </a>
|
|
<a href="/contact.html">Contact</a>
|
|
</nav>
|
|
<button class="theme-toggle" id="theme-toggle" type="button" aria-label="Toggle dark mode">🌗 Theme</button>
|
|
</div>
|
|
<div id="updated">Updated: 2025-08-08 Fri 20:25</div>
|
|
</div>
|
|
<div id="content" class="content">
|
|
<h1 class="title">Setup</h1>
|
|
<div id="outline-container-org417d10f" class="outline-2">
|
|
<h2 id="org417d10f">Introduction</h2>
|
|
<div class="outline-text-2" id="text-org417d10f">
|
|
<p>
|
|
This page will highlight the <code>build-script.el</code> used to generate this website. This entire website is generated through org files using the command:
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-bash">emacs -Q --script build-site.el
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="outline-container-orgcb8faa6" class="outline-2">
|
|
<h2 id="orgcb8faa6">The script</h2>
|
|
<div class="outline-text-2" id="text-orgcb8faa6">
|
|
<p>
|
|
The script is as follows, at the start I have some metadata relating to the file, followed by package management,then the declaration of variables/functions and finally the <code>org-publish-project-alist</code> which handles nearly all of the project generation instructions.
|
|
</p>
|
|
|
|
<p>
|
|
<i>The following code snippet will probably change often, as I can never seem to stick to a single configuration 😀</i>
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-emacs-lisp">
|
|
<span class="org-comment-delimiter">;;; </span><span class="org-comment">build-site.el --- Publish my website using org-publish -*- lexical-binding: t; -*-
|
|
</span>
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">Author: Zaine Qayyum <a href="mailto:zaineulabideen%40outlook.com"><zaineulabideen@outlook.com></a>
|
|
</span><span class="org-comment-delimiter">;; </span><span class="org-comment">Created: 2025-08-08
|
|
</span><span class="org-comment-delimiter">;; </span><span class="org-comment">Purpose: Build and publish my static site from Org files.
|
|
</span>
|
|
<span class="org-comment-delimiter">;;; </span><span class="org-comment">Commentary:
|
|
</span><span class="org-comment-delimiter">;; </span><span class="org-comment">Run this file with:
|
|
</span><span class="org-comment-delimiter">;; </span><span class="org-comment">emacs -Q --script build-site.el
|
|
</span>
|
|
<span class="org-comment-delimiter">;;; </span><span class="org-comment">Code:
|
|
</span>
|
|
(<span class="org-keyword">require</span> '<span class="org-constant">package</span>)
|
|
(<span class="org-keyword">setq</span> package-user-dir (expand-file-name <span class="org-string">"./.packages"</span>))
|
|
(<span class="org-keyword">setq</span> package-archives '((<span class="org-string">"melpa"</span> . <span class="org-string">"https://melpa.org/packages/"</span>)
|
|
(<span class="org-string">"elpa"</span> . <span class="org-string">"https://elpa.gnu.org/packages/"</span>)))
|
|
|
|
(<span class="org-keyword">require</span> '<span class="org-constant">ox-publish</span>)
|
|
(<span class="org-keyword">require</span> '<span class="org-constant">cl-lib</span>)
|
|
(<span class="org-keyword">require</span> '<span class="org-constant">org</span>)
|
|
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">Initialize the package system
|
|
</span>(package-initialize)
|
|
(<span class="org-keyword">unless</span> package-archive-contents
|
|
(package-refresh-contents))
|
|
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">Install dependencies
|
|
</span>(package-install 'htmlize)
|
|
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">Load the publishing system
|
|
</span>(<span class="org-keyword">setq</span> org-html-htmlize-output-type 'css)
|
|
(<span class="org-keyword">setq</span> org-html-head-include-default-style nil)
|
|
|
|
(<span class="org-keyword">defvar</span> <span class="org-variable-name">z-shared-head</span>
|
|
<span class="org-string">"
|
|
<link rel=\"stylesheet\" href=\"https://gongzhitaao.org/orgcss/org.css\" /> <link rel=\"stylesheet\" href=\"/assets/style.css\" /> <script src=\"/assets/script.js\" defer></script> "</span>)
|
|
|
|
(<span class="org-keyword">defvar</span> <span class="org-variable-name">z-preamble</span>
|
|
<span class="org-string">"
|
|
<div class=\"banner-header\">
|
|
<a href=\"/\"> <img src=\"/assets/gr.png\" alt=\"Site Logo\" class=\"banner-logo\" /> </a>
|
|
<nav>
|
|
<a href=\"/\">Home | </a>
|
|
<a href=\"/posts/posts-list.html\">Posts | </a>
|
|
<a href=\"/blogs/blogs-list.html\">Blogs | </a>
|
|
<a href=\"/contact.html\">Contact</a>
|
|
</nav>
|
|
</div>
|
|
<div id=\"updated\">Updated: %C</div>"</span>
|
|
)
|
|
|
|
(<span class="org-keyword">defvar</span> <span class="org-variable-name">z-postamble</span>
|
|
<span class="org-string">"<footer>
|
|
<div class=\"copyright-container\">
|
|
<div class=\"copyright\">
|
|
Copyright &copy; 2022-2025 Zaine Qayyum. All rights reserved unless otherwise noted.</div></div>
|
|
<div class=\"generated\">
|
|
Created with %c on <a href=\"https://www.archlinux.org/\">Arch</a> <a href=\"https://www.gnu.org\">GNU</a>/<a href=\"https://www.kernel.org/\">Linux</a>
|
|
</div>
|
|
</footer>"</span>)
|
|
|
|
|
|
|
|
(<span class="org-keyword">defun</span> <span class="org-function-name">z/posts-sitemap</span> (title list)
|
|
<span class="org-doc">"sitemap that lists post links as bullet points with dates and tags."</span>
|
|
(concat
|
|
<span class="org-string">"#+TITLE: "</span> title <span class="org-string">"\n"</span>
|
|
<span class="org-string">"#+OPTIONS: toc:nil num:nil \n\n"</span>
|
|
<span class="org-string">"See the categories: @@html:<a href=\"../categories.html\">Categories</a>@@\n\n"</span>
|
|
<span class="org-string">"* Posts:\n"</span>
|
|
(mapconcat
|
|
(<span class="org-keyword">lambda</span> (entry)
|
|
(<span class="org-keyword">let*</span> ((link (car entry))
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">extract relative file name from the link
|
|
</span> (filename (<span class="org-keyword">if</span> (string-match <span class="org-string">"\\[\\[file:</span><span class="org-string"><span class="org-regexp-grouping-backslash">\\</span></span><span class="org-string"><span class="org-regexp-grouping-construct">(</span></span><span class="org-string">[</span><span class="org-string"><span class="org-negation-char">^</span></span><span class="org-string">]]+</span><span class="org-string"><span class="org-regexp-grouping-backslash">\\</span></span><span class="org-string"><span class="org-regexp-grouping-construct">)</span></span><span class="org-string">\\]"</span> link)
|
|
(match-string 1 link)
|
|
link))
|
|
(full-path (expand-file-name filename <span class="org-string">"~/master-folder/org_files/org_web/posts/"</span>))
|
|
(date-str <span class="org-string">"no date"</span>)
|
|
(tags-str <span class="org-string">""</span>))
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">Get publish date
|
|
</span> (<span class="org-keyword">let</span> ((date (org-publish-find-date full-path org-publish-project-alist)))
|
|
(<span class="org-keyword">when</span> date
|
|
(<span class="org-keyword">setq</span> date-str (format-time-string <span class="org-string">"%Y-%m-%d"</span> date))))
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">Get FILETAGS from file buffer
|
|
</span> (<span class="org-keyword">when</span> (file-exists-p full-path)
|
|
(<span class="org-keyword">with-temp-buffer</span>
|
|
(insert-file-contents full-path)
|
|
(org-mode)
|
|
(<span class="org-keyword">let*</span> ((tags (cadr (assoc <span class="org-string">"FILETAGS"</span> (org-collect-keywords '(<span class="org-string">"FILETAGS"</span>))))))
|
|
(<span class="org-keyword">when</span> tags
|
|
(<span class="org-keyword">setq</span> tags-str (mapconcat (<span class="org-keyword">lambda</span> (tag)
|
|
(format <span class="org-string">"@@html:<span class=\"post-tag\">%s</span>@@"</span> tag))
|
|
(split-string tags <span class="org-string">":"</span> t) <span class="org-comment-delimiter">;; </span><span class="org-comment"><- Splits by ":" and removes empty strings
|
|
</span> <span class="org-string">" "</span>))))))
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">Final line output
|
|
</span> (format <span class="org-string">"- %s @@html:<span class=\"post-date\">%s</span>@@ %s"</span> link date-str tags-str)))
|
|
(cdr list)
|
|
<span class="org-string">"\n"</span>)))
|
|
|
|
|
|
(<span class="org-keyword">defun</span> <span class="org-function-name">z/blogs-sitemap</span> (title list)
|
|
<span class="org-doc">"sitemap that lists blog links as bullet points with dates and tags."</span>
|
|
(concat
|
|
<span class="org-string">"#+TITLE: "</span> title <span class="org-string">"\n"</span>
|
|
<span class="org-string">"#+OPTIONS: toc:nil num:nil \n\n"</span>
|
|
<span class="org-string">"See the categories: @@html:<a href=\"../categories.html\">Categories</a>@@\n\n"</span>
|
|
<span class="org-string">"* Blogs:\n"</span>
|
|
(mapconcat
|
|
(<span class="org-keyword">lambda</span> (entry)
|
|
(<span class="org-keyword">let*</span> ((link (car entry))
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">extract relative file name from the link
|
|
</span> (filename (<span class="org-keyword">if</span> (string-match <span class="org-string">"\\[\\[file:</span><span class="org-string"><span class="org-regexp-grouping-backslash">\\</span></span><span class="org-string"><span class="org-regexp-grouping-construct">(</span></span><span class="org-string">[</span><span class="org-string"><span class="org-negation-char">^</span></span><span class="org-string">]]+</span><span class="org-string"><span class="org-regexp-grouping-backslash">\\</span></span><span class="org-string"><span class="org-regexp-grouping-construct">)</span></span><span class="org-string">\\]"</span> link)
|
|
(match-string 1 link)
|
|
link))
|
|
(full-path (expand-file-name filename <span class="org-string">"~/master-folder/org_files/org_web/blogs/"</span>))
|
|
(date-str <span class="org-string">"no date"</span>)
|
|
(tags-str <span class="org-string">""</span>))
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">Get publish date
|
|
</span> (<span class="org-keyword">let</span> ((date (org-publish-find-date full-path org-publish-project-alist)))
|
|
(<span class="org-keyword">when</span> date
|
|
(<span class="org-keyword">setq</span> date-str (format-time-string <span class="org-string">"%Y-%m-%d"</span> date))))
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">Get FILETAGS from file buffer
|
|
</span> (<span class="org-keyword">when</span> (file-exists-p full-path)
|
|
(<span class="org-keyword">with-temp-buffer</span>
|
|
(insert-file-contents full-path)
|
|
(org-mode)
|
|
(<span class="org-keyword">let*</span> ((tags (cadr (assoc <span class="org-string">"FILETAGS"</span> (org-collect-keywords '(<span class="org-string">"FILETAGS"</span>))))))
|
|
(<span class="org-keyword">when</span> tags
|
|
(<span class="org-keyword">setq</span> tags-str (mapconcat (<span class="org-keyword">lambda</span> (tag)
|
|
(format <span class="org-string">"@@html:<span class=\"post-tag\">%s</span>@@"</span> tag))
|
|
(split-string tags <span class="org-string">":"</span> t) <span class="org-comment-delimiter">;; </span><span class="org-comment"><- Splits by ":" and removes empty strings
|
|
</span> <span class="org-string">" "</span>))))))
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">Final line output
|
|
</span> (format <span class="org-string">"- %s @@html:<span class=\"post-date\">%s</span>@@ %s"</span> link date-str tags-str)))
|
|
(cdr list)
|
|
<span class="org-string">"\n"</span>)))
|
|
|
|
|
|
|
|
(<span class="org-keyword">defun</span> <span class="org-function-name">z/categories-sitemap</span> (title _list)
|
|
<span class="org-doc">"Generate a categories page by scanning tags across org-posts and org-blogs."</span>
|
|
(<span class="org-keyword">let*</span> ((expanded (org-publish-expand-projects org-publish-project-alist))
|
|
(posts (assoc <span class="org-string">"org-posts"</span> expanded))
|
|
(blogs (assoc <span class="org-string">"org-blogs"</span> expanded))
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">DO NOT set :exclude to "" — it excludes everything
|
|
</span> (files (cl-remove-duplicates
|
|
(append (<span class="org-keyword">and</span> posts (org-publish-get-base-files posts))
|
|
(<span class="org-keyword">and</span> blogs (org-publish-get-base-files blogs)))
|
|
<span class="org-builtin">:test</span> #'file-equal-p))
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">optional: drop the generated sitemaps
|
|
</span> (files (cl-remove-if
|
|
(<span class="org-keyword">lambda</span> (f)
|
|
(member (file-name-nondirectory f)
|
|
'(<span class="org-string">"posts-list.org"</span> <span class="org-string">"blogs-list.org"</span> <span class="org-string">"sitemap.org"</span> <span class="org-string">"categories.org"</span>)))
|
|
files))
|
|
(counts (make-hash-table <span class="org-builtin">:test</span> 'equal)))
|
|
<span class="org-comment-delimiter">;;</span><span class="org-comment">(message "files I will scan: %S" files)
|
|
</span> (<span class="org-keyword">dolist</span> (f files)
|
|
(<span class="org-keyword">when</span> (file-readable-p f)
|
|
(<span class="org-keyword">with-temp-buffer</span>
|
|
(insert-file-contents f)
|
|
(org-mode)
|
|
(<span class="org-keyword">let*</span> ((kw (org-collect-keywords '(<span class="org-string">"FILETAGS"</span> <span class="org-string">"TAGS"</span>)))
|
|
(raw (car (<span class="org-keyword">or</span> (cdr (assoc <span class="org-string">"FILETAGS"</span> kw))
|
|
(cdr (assoc <span class="org-string">"TAGS"</span> kw))))))
|
|
(<span class="org-keyword">when</span> raw
|
|
(<span class="org-keyword">dolist</span> (tag (split-string raw <span class="org-string">":"</span> t))
|
|
(puthash tag (1+ (gethash tag counts 0)) counts)))))))
|
|
|
|
(<span class="org-keyword">let</span> (tags)
|
|
(maphash (<span class="org-keyword">lambda</span> (k _) (<span class="org-keyword">push</span> k tags)) counts)
|
|
(<span class="org-keyword">setq</span> tags (sort tags #'string-lessp))
|
|
(concat
|
|
<span class="org-string">"#+TITLE: "</span> title <span class="org-string">"\n#+OPTIONS: toc:nil num:nil title:nil\n\n* Categories (Includes both blogs and posts)\n"</span>
|
|
(<span class="org-keyword">if</span> tags
|
|
(mapconcat
|
|
(<span class="org-keyword">lambda</span> (tag)
|
|
(format <span class="org-string">"- [[file:tags/%s.org][@@html:<span class=\"post-tag\">%s</span>@@]] (%d)"</span>
|
|
(z/tag-slug tag) tag (gethash tag counts))
|
|
)
|
|
tags
|
|
<span class="org-string">"\n"</span>)
|
|
<span class="org-string">"_No tags found yet._"</span>)))))
|
|
|
|
|
|
(<span class="org-keyword">defun</span> <span class="org-function-name">z/tag-slug</span> (s)
|
|
<span class="org-doc">"Turn a tag into a safe filename."</span>
|
|
(<span class="org-keyword">let</span> ((down (downcase s)))
|
|
(replace-regexp-in-string <span class="org-string">"[</span><span class="org-string"><span class="org-negation-char">^</span></span><span class="org-string">a-z0-9]+"</span> <span class="org-string">"-"</span> down)))
|
|
|
|
(<span class="org-keyword">defun</span> <span class="org-function-name">z/collect-post-files</span> ()
|
|
<span class="org-doc">"Return all .org files from org-posts and org-blogs."</span>
|
|
(<span class="org-keyword">let*</span> ((expanded (org-publish-expand-projects org-publish-project-alist))
|
|
(posts (assoc <span class="org-string">"org-posts"</span> expanded))
|
|
(blogs (assoc <span class="org-string">"org-blogs"</span> expanded)))
|
|
(cl-remove-duplicates
|
|
(append (<span class="org-keyword">and</span> posts (org-publish-get-base-files posts))
|
|
(<span class="org-keyword">and</span> blogs (org-publish-get-base-files blogs)))
|
|
<span class="org-builtin">:test</span> #'file-equal-p)))
|
|
|
|
(<span class="org-keyword">defun</span> <span class="org-function-name">z/gather-tag-index</span> ()
|
|
<span class="org-doc">"Return hash: tag -> list of (FILE TITLE DATE-ISO)."</span>
|
|
(<span class="org-keyword">let</span> ((idx (make-hash-table <span class="org-builtin">:test</span> 'equal)))
|
|
(<span class="org-keyword">dolist</span> (f (z/collect-post-files))
|
|
(<span class="org-keyword">when</span> (<span class="org-keyword">and</span> (string-match-p <span class="org-string">"\\.org\\'"</span> f)
|
|
(file-readable-p f)
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">ignore generated lists
|
|
</span> (not (member (file-name-nondirectory f)
|
|
'(<span class="org-string">"posts-list.org"</span> <span class="org-string">"blogs-list.org"</span> <span class="org-string">"sitemap.org"</span> <span class="org-string">"categories.org"</span>))))
|
|
(<span class="org-keyword">with-temp-buffer</span>
|
|
(insert-file-contents f)
|
|
(org-mode)
|
|
(<span class="org-keyword">let*</span> ((kw (org-collect-keywords '(<span class="org-string">"TITLE"</span> <span class="org-string">"FILETAGS"</span> <span class="org-string">"TAGS"</span> <span class="org-string">"DATE"</span>)))
|
|
(title (<span class="org-keyword">or</span> (car (cdr (assoc <span class="org-string">"TITLE"</span> kw)))
|
|
(file-name-base f)))
|
|
(date (<span class="org-keyword">or</span> (car (cdr (assoc <span class="org-string">"DATE"</span> kw))) <span class="org-string">""</span>)) <span class="org-comment-delimiter">;; </span><span class="org-comment">optional
|
|
</span> (raw (car (<span class="org-keyword">or</span> (cdr (assoc <span class="org-string">"FILETAGS"</span> kw))
|
|
(cdr (assoc <span class="org-string">"TAGS"</span> kw))))))
|
|
(<span class="org-keyword">when</span> raw
|
|
(<span class="org-keyword">dolist</span> (tag (split-string raw <span class="org-string">":"</span> t))
|
|
(<span class="org-keyword">push</span> (list f title date) (gethash tag idx))))))))
|
|
idx))
|
|
|
|
(<span class="org-keyword">defun</span> <span class="org-function-name">z/write-tag-pages</span> ()
|
|
<span class="org-doc">"Generate tags/*.org pages listing posts for each tag."</span>
|
|
(<span class="org-keyword">let*</span> ((site-root (expand-file-name <span class="org-string">"~/master-folder/org_files/org_web/"</span>))
|
|
(tags-dir (expand-file-name <span class="org-string">"tags"</span> site-root)))
|
|
(<span class="org-keyword">unless</span> (file-directory-p tags-dir)
|
|
(make-directory tags-dir t))
|
|
(<span class="org-keyword">let</span> ((idx (z/gather-tag-index)))
|
|
(maphash
|
|
(<span class="org-keyword">lambda</span> (tag items)
|
|
(<span class="org-keyword">let*</span> ((slug (z/tag-slug tag))
|
|
(outfile (expand-file-name (format <span class="org-string">"%s.org"</span> slug) tags-dir)))
|
|
(<span class="org-keyword">with-temp-file</span> outfile
|
|
(insert (format <span class="org-string">"#+TITLE: Tag: %s\n#+OPTIONS: toc:nil num:nil title:nil \n\n* Posts tagged %s\n"</span>
|
|
tag tag))
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">sort newest first if DATE present
|
|
</span> (<span class="org-keyword">setq</span> items (sort items (<span class="org-keyword">lambda</span> (a b) (string> (nth 2 a) (nth 2 b)))))
|
|
(<span class="org-keyword">dolist</span> (it items)
|
|
(<span class="org-keyword">let*</span> ((file (nth 0 it))
|
|
(title (nth 1 it))
|
|
(rel (file-relative-name file tags-dir)))
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">link to the source .org; org-publish will rewrite to the .html
|
|
</span> (insert (format <span class="org-string">"- [[file:%s][%s]]\n"</span> rel title)))))))
|
|
idx)
|
|
)))
|
|
|
|
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">Define the publishing project
|
|
</span>(<span class="org-keyword">setq</span> org-publish-project-alist
|
|
`((<span class="org-string">"org-main"</span>
|
|
<span class="org-builtin">:recursive</span> t
|
|
<span class="org-builtin">:base-directory</span> <span class="org-string">"~/master-folder/org_files/org_web/"</span>
|
|
<span class="org-builtin">:publishing-function</span> org-html-publish-to-html
|
|
<span class="org-builtin">:publishing-directory</span> <span class="org-string">"~/master-folder/org_files/org_web/output"</span>
|
|
<span class="org-builtin">:with-author</span> nil
|
|
<span class="org-builtin">:with-creator</span> t
|
|
<span class="org-builtin">:with-toc</span> t
|
|
<span class="org-builtin">:base-extension</span> <span class="org-string">"org"</span>
|
|
<span class="org-builtin">:section-numbers</span> nil
|
|
<span class="org-builtin">:time-stamp-file</span> nil
|
|
<span class="org-builtin">:auto-sitemap</span> t
|
|
<span class="org-builtin">:sitemap-filename</span> <span class="org-string">"sitemap.org"</span>
|
|
<span class="org-builtin">:sitemap-title</span> <span class="org-string">"Sitemap"</span>
|
|
<span class="org-builtin">:sitemap-sort-files</span> chronologically
|
|
<span class="org-builtin">:html-preamble</span> ,z-preamble
|
|
<span class="org-builtin">:html-postamble</span> ,z-postamble
|
|
<span class="org-builtin">:html-head</span> ,z-shared-head)
|
|
(<span class="org-string">"org-categories-sitemap"</span>
|
|
<span class="org-builtin">:recursive</span> t
|
|
<span class="org-builtin">:base-directory</span> <span class="org-string">"~/master-folder/org_files/org_web/"</span>
|
|
<span class="org-builtin">:publishing-directory</span> <span class="org-string">"~/master-folder/org_files/org_web/output"</span>
|
|
<span class="org-builtin">:base-extension</span> <span class="org-string">"org"</span>
|
|
<span class="org-builtin">:auto-sitemap</span> t
|
|
<span class="org-builtin">:sitemap-filename</span> <span class="org-string">"categories.org"</span>
|
|
<span class="org-builtin">:sitemap-title</span> <span class="org-string">"Categories"</span>
|
|
<span class="org-builtin">:sitemap-function</span> z/categories-sitemap
|
|
<span class="org-builtin">:html-preamble</span> ,z-preamble
|
|
<span class="org-builtin">:html-postamble</span> ,z-postamble
|
|
<span class="org-builtin">:html-head</span> ,z-shared-head)
|
|
(<span class="org-string">"org-posts"</span>
|
|
<span class="org-builtin">:base-directory</span> <span class="org-string">"~/master-folder/org_files/org_web/posts"</span>
|
|
<span class="org-builtin">:publishing-directory</span> <span class="org-string">"~/master-folder/org_files/org_web/output/posts/"</span>
|
|
<span class="org-builtin">:recursive</span> t
|
|
<span class="org-builtin">:base-extension</span> <span class="org-string">"org"</span>
|
|
<span class="org-builtin">:publishing-function</span> org-html-publish-to-html
|
|
<span class="org-builtin">:with-author</span> nil
|
|
<span class="org-builtin">:with-creator</span> nil
|
|
<span class="org-builtin">:html-validation-link</span> nil
|
|
<span class="org-builtin">:with-toc</span> t
|
|
<span class="org-builtin">:section-numbers</span> t
|
|
<span class="org-builtin">:html-preamble</span> ,z-preamble
|
|
<span class="org-builtin">:html-postamble</span> ,z-postamble
|
|
<span class="org-builtin">:auto-sitemap</span> t
|
|
<span class="org-builtin">:sitemap-filename</span> <span class="org-string">"posts-list.org"</span>
|
|
<span class="org-builtin">:sitemap-title</span> <span class="org-string">"Posts List"</span>
|
|
<span class="org-builtin">:sitemap-style</span> list
|
|
<span class="org-builtin">:sitemap-function</span> z/posts-sitemap
|
|
<span class="org-builtin">:html-head</span> ,z-shared-head)
|
|
(<span class="org-string">"org-blogs"</span>
|
|
<span class="org-builtin">:base-directory</span> <span class="org-string">"~/master-folder/org_files/org_web/blogs"</span>
|
|
<span class="org-builtin">:publishing-directory</span> <span class="org-string">"~/master-folder/org_files/org_web/output/blogs/"</span>
|
|
<span class="org-builtin">:recursive</span> t
|
|
<span class="org-builtin">:base-extension</span> <span class="org-string">"org"</span>
|
|
<span class="org-builtin">:publishing-function</span> org-html-publish-to-html
|
|
<span class="org-builtin">:with-author</span> nil
|
|
<span class="org-builtin">:with-creator</span> nil
|
|
<span class="org-builtin">:html-validation-link</span> nil
|
|
<span class="org-builtin">:html-preamble</span> ,z-preamble
|
|
<span class="org-builtin">:html-postamble</span> ,z-postamble
|
|
<span class="org-builtin">:auto-sitemap</span> t
|
|
<span class="org-builtin">:sitemap-filename</span> <span class="org-string">"blogs-list.org"</span>
|
|
<span class="org-builtin">:sitemap-title</span> <span class="org-string">"Blogs List"</span>
|
|
<span class="org-builtin">:sitemap-style</span> list
|
|
<span class="org-builtin">:sitemap-function</span> z/blogs-sitemap
|
|
<span class="org-builtin">:html-head</span> ,z-shared-head)
|
|
(<span class="org-string">"org-tags"</span>
|
|
<span class="org-builtin">:base-directory</span> <span class="org-string">"~/master-folder/org_files/org_web/tags"</span>
|
|
<span class="org-builtin">:publishing-directory</span> <span class="org-string">"~/master-folder/org_files/org_web/output/tags"</span>
|
|
<span class="org-builtin">:recursive</span> t
|
|
<span class="org-builtin">:base-extension</span> <span class="org-string">"org"</span>
|
|
<span class="org-builtin">:publishing-function</span> org-html-publish-to-html
|
|
<span class="org-builtin">:with-author</span> nil
|
|
<span class="org-builtin">:with-creator</span> nil
|
|
<span class="org-builtin">:html-preamble</span> ,z-preamble
|
|
<span class="org-builtin">:html-postamble</span> ,z-postamble
|
|
<span class="org-builtin">:html-head</span> ,z-shared-head)
|
|
(<span class="org-string">"org-assets"</span>
|
|
<span class="org-builtin">:base-directory</span> <span class="org-string">"~/master-folder/org_files/org_web/assets/"</span>
|
|
<span class="org-builtin">:base-extension</span> <span class="org-string">"css</span><span class="org-string"><span class="org-regexp-grouping-backslash">\\</span></span><span class="org-string"><span class="org-regexp-grouping-construct">|</span></span><span class="org-string">js</span><span class="org-string"><span class="org-regexp-grouping-backslash">\\</span></span><span class="org-string"><span class="org-regexp-grouping-construct">|</span></span><span class="org-string">png</span><span class="org-string"><span class="org-regexp-grouping-backslash">\\</span></span><span class="org-string"><span class="org-regexp-grouping-construct">|</span></span><span class="org-string">jpg</span><span class="org-string"><span class="org-regexp-grouping-backslash">\\</span></span><span class="org-string"><span class="org-regexp-grouping-construct">|</span></span><span class="org-string">gif</span><span class="org-string"><span class="org-regexp-grouping-backslash">\\</span></span><span class="org-string"><span class="org-regexp-grouping-construct">|</span></span><span class="org-string">svg</span><span class="org-string"><span class="org-regexp-grouping-backslash">\\</span></span><span class="org-string"><span class="org-regexp-grouping-construct">|</span></span><span class="org-string">pdf</span><span class="org-string"><span class="org-regexp-grouping-backslash">\\</span></span><span class="org-string"><span class="org-regexp-grouping-construct">|</span></span><span class="org-string">woff</span><span class="org-string"><span class="org-regexp-grouping-backslash">\\</span></span><span class="org-string"><span class="org-regexp-grouping-construct">|</span></span><span class="org-string">woff2</span><span class="org-string"><span class="org-regexp-grouping-backslash">\\</span></span><span class="org-string"><span class="org-regexp-grouping-construct">|</span></span><span class="org-string">ttf"</span>
|
|
<span class="org-builtin">:publishing-directory</span> <span class="org-string">"~/master-folder/org_files/org_web/output/assets/"</span>
|
|
<span class="org-builtin">:recursive</span> t
|
|
<span class="org-builtin">:publishing-function</span> org-publish-attachment)
|
|
))
|
|
|
|
(delete-directory <span class="org-string">"~/master-folder/org_files/org_web/output/"</span> t)
|
|
(delete-directory <span class="org-string">"~/master-folder/org_files/org_web/tags/"</span> t)
|
|
(message <span class="org-string">"Directory deleted"</span>)
|
|
|
|
<span class="org-comment-delimiter">;; </span><span class="org-comment">Generate the site output
|
|
</span>(z/write-tag-pages)
|
|
(org-publish-all t)
|
|
|
|
(message <span class="org-string">"Build complete!"</span>)
|
|
|
|
<span class="org-comment-delimiter">;;; </span><span class="org-comment">build-site.el ends here
|
|
</span>
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="outline-container-orgb101495" class="outline-2">
|
|
<h2 id="orgb101495">Publish Script</h2>
|
|
<div class="outline-text-2" id="text-orgb101495">
|
|
<p>
|
|
As the project is hosted on Github, I have created a small script that is able to push changes to the remote repository, which Cloudflare will automatically detect and rebuild the website:
|
|
</p>
|
|
|
|
<div class="org-src-container">
|
|
<pre class="src src-bash">
|
|
<span class="org-comment-delimiter">#</span><span class="org-comment">!/bin/bash
|
|
</span>
|
|
<span class="org-comment-delimiter"># </span><span class="org-comment">Exit immediately if any command fails
|
|
</span><span class="org-builtin">set</span> -e
|
|
|
|
<span class="org-comment-delimiter"># </span><span class="org-comment">Define paths
|
|
</span><span class="org-variable-name">ORG_PROJECT_NAME</span>=<span class="org-string">"website"</span>
|
|
<span class="org-variable-name">ORG_OUTPUT_DIR</span>=<span class="org-string">"$HOME/master-folder/org_files/org_web/output"</span>
|
|
|
|
<span class="org-comment-delimiter"># </span><span class="org-comment">commands used prior to having the `build-script.el`
|
|
</span><span class="org-comment-delimiter"># </span><span class="org-comment">echo "Running org-publish..."
|
|
</span><span class="org-comment-delimiter"># </span><span class="org-comment">emacs --batch \
|
|
</span><span class="org-comment-delimiter"># </span><span class="org-comment">--eval "(require 'org)" \
|
|
</span><span class="org-comment-delimiter"># </span><span class="org-comment">--eval "(require 'ox-publish)" \
|
|
</span><span class="org-comment-delimiter"># </span><span class="org-comment">--eval "(org-publish \"$ORG_PROJECT_NAME\" t)"
|
|
</span>
|
|
<span class="org-builtin">cd</span> <span class="org-string">"$ORG_OUTPUT_DIR"</span>
|
|
|
|
<span class="org-builtin">echo</span> <span class="org-string">"HTML published to: $ORG_OUTPUT_DIR"</span>
|
|
|
|
<span class="org-comment-delimiter"># </span><span class="org-comment">Git commands
|
|
</span><span class="org-builtin">echo</span> <span class="org-string">"Adding changes to Git..."</span>
|
|
git add .
|
|
|
|
<span class="org-builtin">echo</span> <span class="org-string">"Committing..."</span>
|
|
git commit -m <span class="org-string">"Auto-publish on $(date)"</span> || <span class="org-builtin">echo</span> <span class="org-string">"Nothing to commit."</span>
|
|
|
|
<span class="org-builtin">echo</span> <span class="org-string">"Pushing to GitHub..."</span>
|
|
git push origin main
|
|
|
|
<span class="org-builtin">echo</span> <span class="org-string">"Done! Changes pushed and Cloudflare should rebuild the site."</span>
|
|
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="postamble" class="status">
|
|
<footer>
|
|
<div class="copyright-container">
|
|
<div class="copyright">
|
|
Copyright © 2022-2025 Zaine Qayyum. All rights reserved unless otherwise noted.</div></div>
|
|
<div class="generated">
|
|
Created with <a href="https://www.gnu.org/software/emacs/">Emacs</a> 30.1 (<a href="https://orgmode.org">Org</a> mode 9.7.11) on <a href="https://www.archlinux.org/">Arch</a> <a href="https://www.gnu.org">GNU</a>/<a href="https://www.kernel.org/">Linux</a>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
</body>
|
|
</html>
|