blog/_output/tweaks.html

187 lines
15 KiB
HTML

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>Tweaks</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
pre > code.sourceCode { white-space: pre-wrap; }
pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
}
pre.numberSource code
{ counter-reset: source-line 0; }
pre.numberSource code > span
{ position: relative; left: -4em; counter-increment: source-line; }
pre.numberSource code > span > a:first-child::before
{ content: counter(source-line);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; display: inline-block;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
color: #aaaaaa;
}
pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
div.sourceCode
{ }
@media screen {
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
}
code span.al { color: #ff0000; font-weight: bold; } /* Alert */
code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code span.at { color: #7d9029; } /* Attribute */
code span.bn { color: #40a070; } /* BaseN */
code span.bu { } /* BuiltIn */
code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code span.ch { color: #4070a0; } /* Char */
code span.cn { color: #880000; } /* Constant */
code span.co { color: #60a0b0; font-style: italic; } /* Comment */
code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code span.do { color: #ba2121; font-style: italic; } /* Documentation */
code span.dt { color: #902000; } /* DataType */
code span.dv { color: #40a070; } /* DecVal */
code span.er { color: #ff0000; font-weight: bold; } /* Error */
code span.ex { } /* Extension */
code span.fl { color: #40a070; } /* Float */
code span.fu { color: #06287e; } /* Function */
code span.im { } /* Import */
code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
code span.kw { color: #007020; font-weight: bold; } /* Keyword */
code span.op { color: #666666; } /* Operator */
code span.ot { color: #007020; } /* Other */
code span.pp { color: #bc7a00; } /* Preprocessor */
code span.sc { color: #4070a0; } /* SpecialChar */
code span.ss { color: #bb6688; } /* SpecialString */
code span.st { color: #4070a0; } /* String */
code span.va { color: #19177c; } /* Variable */
code span.vs { color: #4070a0; } /* VerbatimString */
code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
</style>
<link rel="stylesheet" href="style.css" />
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
<![endif]-->
</head>
<body>
<!-- Content placed here will appear directly after the opening <body> tag -->
<nav>
<a href="/">Home</a><span>&nbsp;/&nbsp;</span>
<a href="/blog">Blog</a><span>&nbsp;/&nbsp;</span>
<a href="/tweaks.html">Tweaks</a><span>&nbsp;/&nbsp;</span>
<a href="https://codeberg.org/tdarb/pblog">Download</a>
</nav>
<!-- Do not remove this opening article element -->
<article>
<header id="title-block-header">
<h1 class="title">Tweaks</h1>
</header>
<nav id="TOC" role="doc-toc">
<ul>
<li><a href="#tweaks-explained" id="toc-tweaks-explained">Tweaks Explained</a></li>
<li><a href="#magick-images" id="toc-magick-images">Magick Images</a></li>
<li><a href="#hiding-table-of-contents-heading" id="toc-hiding-table-of-contents-heading">Hiding Table of Contents &#x201C;Heading&#x201D;</a></li>
<li><a href="#adding-navigation-to-blog-index-and-rss-feed" id="toc-adding-navigation-to-blog-index-and-rss-feed">Adding navigation to blog index and RSS feed</a></li>
</ul>
</nav>
<h2 id="tweaks-explained">Tweaks Explained</h2>
<p>&#x201C;Tweaks&#x201D; are extra features that are not packaged within the default <code>pblog</code> project. If you have your own tweaks you would like to include, be sure to <a href="https://git.sr.ht/~tdarb/pblog.xyz">open a patch</a>.</p>
<hr />
<p><br></p>
<h2 id="magick-images">Magick Images</h2>
<h4 id="by-matthew-graybosch">by: <a href="https://matthewgraybosch.com">Matthew Graybosch</a></h4>
<p>This tweak gives you the ability to automatically convert PNG and JPG images to WEBP and AVIF files when used with the <code>picture</code> HTML element.</p>
<p><strong>Requirements</strong>:</p>
<ul>
<li>Download and install <a href="https://imagemagick.org/script/download.php">ImageMagick</a></li>
</ul>
<p>Then change your base <code>makefile</code> to reflect the following:</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="ex">.SUFFIXES:</span> .png .jpg .webp .avif</span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="ex">.jpg.webp:</span></span>
<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a> <span class="ex">magick</span> <span class="at">-quality</span> 80 <span class="st">&quot;$&lt;&quot;</span> <span class="st">&quot;</span><span class="va">$@</span><span class="st">&quot;</span></span>
<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a><span class="ex">.jpg.avif:</span></span>
<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a> <span class="ex">magick</span> <span class="at">-quality</span> 80 <span class="st">&quot;$&lt;&quot;</span> <span class="st">&quot;</span><span class="va">$@</span><span class="st">&quot;</span></span>
<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1-9"><a href="#cb1-9" aria-hidden="true" tabindex="-1"></a><span class="ex">.png.webp:</span></span>
<span id="cb1-10"><a href="#cb1-10" aria-hidden="true" tabindex="-1"></a> <span class="ex">magick</span> <span class="at">-quality</span> 80 <span class="st">&quot;$&lt;&quot;</span> <span class="st">&quot;</span><span class="va">$@</span><span class="st">&quot;</span></span>
<span id="cb1-11"><a href="#cb1-11" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1-12"><a href="#cb1-12" aria-hidden="true" tabindex="-1"></a><span class="ex">.png.avif:</span></span>
<span id="cb1-13"><a href="#cb1-13" aria-hidden="true" tabindex="-1"></a> <span class="ex">magick</span> <span class="at">-quality</span> 80 <span class="st">&quot;$&lt;&quot;</span> <span class="st">&quot;</span><span class="va">$@</span><span class="st">&quot;</span></span>
<span id="cb1-14"><a href="#cb1-14" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1-15"><a href="#cb1-15" aria-hidden="true" tabindex="-1"></a><span class="ex">JPEGS!=find</span> media/ <span class="at">-name</span> <span class="st">&#39;*.jpg&#39;</span></span>
<span id="cb1-16"><a href="#cb1-16" aria-hidden="true" tabindex="-1"></a><span class="ex">PNGS!=find</span> media/ <span class="at">-name</span> <span class="st">&#39;*.png&#39;</span></span>
<span id="cb1-17"><a href="#cb1-17" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1-18"><a href="#cb1-18" aria-hidden="true" tabindex="-1"></a><span class="va">JPEG_WEBP</span><span class="op">=</span><span class="va">${JPEGS</span><span class="op">:</span>.jpg=.webp<span class="va">}</span></span>
<span id="cb1-19"><a href="#cb1-19" aria-hidden="true" tabindex="-1"></a><span class="va">JPEG_AVIF</span><span class="op">=</span><span class="va">${JPEGS</span><span class="op">:</span>.jpg=.avif<span class="va">}</span></span>
<span id="cb1-20"><a href="#cb1-20" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1-21"><a href="#cb1-21" aria-hidden="true" tabindex="-1"></a><span class="va">PNG_WEBP</span><span class="op">=</span><span class="va">${PNGS</span><span class="op">:</span>.png=.webp<span class="va">}</span></span>
<span id="cb1-22"><a href="#cb1-22" aria-hidden="true" tabindex="-1"></a><span class="va">PNG_AVIF</span><span class="op">=</span><span class="va">${PNGS</span><span class="op">:</span>.png=.avif<span class="va">}</span></span>
<span id="cb1-23"><a href="#cb1-23" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1-24"><a href="#cb1-24" aria-hidden="true" tabindex="-1"></a><span class="ex">.DEFAULT:</span> build</span>
<span id="cb1-25"><a href="#cb1-25" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1-26"><a href="#cb1-26" aria-hidden="true" tabindex="-1"></a><span class="ex">.PHONY:</span> build</span>
<span id="cb1-27"><a href="#cb1-27" aria-hidden="true" tabindex="-1"></a><span class="ex">build:</span> <span class="va">$(</span><span class="ex">JPEG_WEBP</span><span class="va">)</span> <span class="va">$(</span><span class="ex">JPEG_AVIF</span><span class="va">)</span> <span class="va">$(</span><span class="ex">PNG_WEBP</span><span class="va">)</span> <span class="va">$(</span><span class="ex">PNG_AVIF</span><span class="va">)</span></span>
<span id="cb1-28"><a href="#cb1-28" aria-hidden="true" tabindex="-1"></a> <span class="fu">bash</span> pblog.sh <span class="op">&gt;</span> _output/feed.xml</span>
<span id="cb1-29"><a href="#cb1-29" aria-hidden="true" tabindex="-1"></a> <span class="ex">xsltproc</span> _output/feed.xml <span class="kw">|</span> <span class="fu">tail</span> <span class="at">-n</span> +2 <span class="op">&gt;</span> _output/blog/index.html</span>
<span id="cb1-30"><a href="#cb1-30" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1-31"><a href="#cb1-31" aria-hidden="true" tabindex="-1"></a><span class="ex">serve:</span> build</span>
<span id="cb1-32"><a href="#cb1-32" aria-hidden="true" tabindex="-1"></a> <span class="ex">python3</span> <span class="at">-m</span> http.server <span class="at">--directory</span> _output/</span>
<span id="cb1-33"><a href="#cb1-33" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb1-34"><a href="#cb1-34" aria-hidden="true" tabindex="-1"></a><span class="ex">clean:</span></span>
<span id="cb1-35"><a href="#cb1-35" aria-hidden="true" tabindex="-1"></a> <span class="fu">rm</span> _output/<span class="pp">*</span> rss/<span class="pp">*</span> <span class="va">$(</span><span class="ex">JPEG_WEBP</span><span class="va">)</span> <span class="va">$(</span><span class="ex">JPEG_AVIF</span><span class="va">)</span> <span class="va">$(</span><span class="ex">PNG_WEBP</span><span class="va">)</span> <span class="va">$(</span><span class="ex">PNG_AVIF</span><span class="va">)</span></span></code></pre></div>
<p>That&#x2019;s it. Enjoy!</p>
<hr />
<p><br></p>
<h2 id="hiding-table-of-contents-heading">Hiding Table of Contents &#x201C;Heading&#x201D;</h2>
<h4 id="by-bradley-taunt">by <a href="https://tdarb.org">Bradley Taunt</a></h4>
<p>By default the include <em>Table of Contents</em> displays a title and styled section. To disable this, simply edit the <code>style.css</code> file and comment out or delete the following:</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode css"><code class="sourceCode css"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="pp">#TOC</span> {</span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a> <span class="kw">border</span>: <span class="dv">1</span><span class="dt">px</span> <span class="dv">solid</span><span class="op">;</span></span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a> <span class="kw">position</span>: <span class="dv">relative</span><span class="op">;</span></span>
<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a>}</span>
<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a><span class="pp">#TOC</span><span class="in">:before</span> {</span>
<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a> <span class="kw">border-bottom</span>: <span class="dv">1</span><span class="dt">px</span> <span class="dv">solid</span><span class="op">;</span></span>
<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a> <span class="kw">content</span>: <span class="st">&#39;Table of Contents&#39;</span><span class="op">;</span></span>
<span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a> <span class="kw">display</span>: <span class="dv">block</span><span class="op">;</span></span>
<span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a> <span class="kw">font-weight</span>: <span class="dv">bold</span><span class="op">;</span></span>
<span id="cb2-10"><a href="#cb2-10" aria-hidden="true" tabindex="-1"></a> <span class="kw">padding</span>: <span class="dv">5</span><span class="dt">px</span><span class="op">;</span></span>
<span id="cb2-11"><a href="#cb2-11" aria-hidden="true" tabindex="-1"></a> <span class="kw">position</span>: <span class="dv">relative</span><span class="op">;</span></span>
<span id="cb2-12"><a href="#cb2-12" aria-hidden="true" tabindex="-1"></a>}</span></code></pre></div>
<hr />
<p><br></p>
<h2 id="adding-navigation-to-blog-index-and-rss-feed">Adding navigation to blog index and RSS feed</h2>
<p>In order to include any main navigation (or other custom elements for that matter) on the main blog index page and RSS <code>feed.xml</code>, simply edit the <code>rss.xml</code> file in the root directory. Be sure to add your elements / content inside the <code>body</code> tag near the bottom of the page.</p>
</article><!-- Do not remove this closing article element -->
<!-- Content placed here will appear directly before the closing </body> tag -->
<footer>
<br>
<hr>
<p><small>Powered by <a href="https://pblog.xyz">pblog</a><br>
Made with &hearts; for a simpler web.<br>
Peanut butter sandwich illustration by Kate Maldjian from NounProject.com</small></p>
</footer>
</body>
</html>