diff options
| author | Bradley Taunt <bt@btxx.org> | 2024-06-06 08:36:27 -0400 |
|---|---|---|
| committer | Bradley Taunt <bt@btxx.org> | 2024-06-06 08:36:27 -0400 |
| commit | 7b2dc83a3a3b2da494e1b1370e3ecac94a9c9342 (patch) | |
| tree | 92f824a90fcd8a692a3e8554da738e4a91cd7b07 | |
| parent | 6b829cb0bb86bd75b872f32f3121722b000ec419 (diff) | |
Include RSS feed generation, check operating system to set aliases
| -rwxr-xr-x | barf | 51 | ||||
| -rw-r--r-- | build/about/index.html | 1 | ||||
| -rw-r--r-- | build/atom.xml | 2 | ||||
| -rw-r--r-- | build/cleanup/index.html | 1 | ||||
| -rw-r--r-- | build/dark-mode/index.html | 1 | ||||
| -rw-r--r-- | build/index.html | 1 | ||||
| -rw-r--r-- | build/macos/index.html | 1 | ||||
| -rw-r--r-- | build/markdown-examples/index.html | 1 | ||||
| -rw-r--r-- | build/openbsd/index.html | 1 | ||||
| -rw-r--r-- | build/rss.xml | 332 | ||||
| -rw-r--r-- | build/websites/index.html | 1 | ||||
| -rw-r--r-- | footer.html | 1 |
12 files changed, 393 insertions, 1 deletions
@@ -1,4 +1,15 @@ #!/bin/sh + +# Check the operating system +os_name=$(uname -s) + +if [ "$os_name" = "OpenBSD" ]; then + alias sed=gsed +elif [ "$os_name" = "Darwin" ]; then + alias sed=gsed + alias date=gdate +fi + set -eu MARKDOWN=smu IFS=' ' @@ -74,6 +85,45 @@ EOF echo '</feed>' } +rss_xml() { + uri=$(sed -rn '/rss.xml/ s/.*href="([^"]*)".*/\1/ p' header.html) + domain=$(echo "$uri" | sed 's/rss.xml//g' | sed 's|/[^/]*$||') + first_commit_date=$(git log --pretty='format:%ai' . | cut -d ' ' -f1 | tail -1) + + cat <<EOF +<?xml version="1.0" encoding="utf-8"?> +<rss version="2.0"> + <channel> + <title>$(sed -n '/^# /{s/# //p; q}' index.md)</title> + <link>$domain/rss.xml</link> + <description>Feed description here</description> + <lastBuildDate>$(date -u +"%a, %d %b %Y %H:%M:%S %z")</lastBuildDate> + <pubDate>$(date -u +"%a, %d %b %Y %H:%M:%S %z")</pubDate> + <generator>Custom RSS Generator</generator> + <ttl>1800</ttl> +EOF + + while read -r f title created; do + content=$($MARKDOWN "$f" | sed 's/&/\&/g; s/</\</g; s/>/\>/g; s/"/\"/g; s/'"'"'/\'/g') + post_link=$(echo "$f" | sed -E 's|posts/(.*).md|\1|') + basic_date=$(echo $(head -3 "$f" | tail -1)) + published_date=$(date -d "$basic_date" -u +"%a, %d %b %Y %H:%M:%S %z") + + cat <<EOF + <item> + <title>$title</title> + <description><![CDATA[$content]]></description> + <link>$domain/$post_link</link> + <guid isPermaLink="false">$domain/$post_link</guid> + <pubDate>$published_date</pubDate> + </item> +EOF + done < "$1" + + echo '</channel>' + echo '</rss>' +} + write_page() { filename=$1 directory=$(echo $(basename "$filename" .md)) @@ -94,6 +144,7 @@ rm -rf build && mkdir build index_tsv posts | sort -rt " " -k 3 > build/posts.tsv index_html build/posts.tsv > build/index.html atom_xml build/posts.tsv > build/atom.xml +rss_xml build/posts.tsv > build/rss.xml while read -r f title created; do write_page "$f" "$title" "$created" done < build/posts.tsv diff --git a/build/about/index.html b/build/about/index.html index f172116..be0489e 100644 --- a/build/about/index.html +++ b/build/about/index.html @@ -29,6 +29,7 @@ <li><a href="https://git.btxx.org/barf">Source Code</a></li> </ul> <small> + Feeds: <a href="/atom.xml">Atom</a> | <a href="/rss.xml">RSS</a> <br> Built with <a href="https://git.btxx.org/barf">barf</a>. <br> The <a href="https://git.btxx.org/barf">code for this site</a> is MIT. </small> diff --git a/build/atom.xml b/build/atom.xml index dc8835d..dfe09d2 100644 --- a/build/atom.xml +++ b/build/atom.xml @@ -2,7 +2,7 @@ <feed xmlns="http://www.w3.org/2005/Atom"> <title>barf</title> <link href="https://barf.btxx.org/atom.xml" rel="self" /> - <updated>2024-06-04T11:19:14Z</updated> + <updated>2024-06-06T08:34:47Z</updated> <author> <name>Bradley Taunt</name> </author> diff --git a/build/cleanup/index.html b/build/cleanup/index.html index 62b6f54..16b7672 100644 --- a/build/cleanup/index.html +++ b/build/cleanup/index.html @@ -42,6 +42,7 @@ pre{overflow:auto;} <li><a href="https://git.btxx.org/barf">Source Code</a></li> </ul> <small> + Feeds: <a href="/atom.xml">Atom</a> | <a href="/rss.xml">RSS</a> <br> Built with <a href="https://git.btxx.org/barf">barf</a>. <br> The <a href="https://git.btxx.org/barf">code for this site</a> is MIT. </small> diff --git a/build/dark-mode/index.html b/build/dark-mode/index.html index dca8874..a5aaf19 100644 --- a/build/dark-mode/index.html +++ b/build/dark-mode/index.html @@ -35,6 +35,7 @@ <li><a href="https://git.btxx.org/barf">Source Code</a></li> </ul> <small> + Feeds: <a href="/atom.xml">Atom</a> | <a href="/rss.xml">RSS</a> <br> Built with <a href="https://git.btxx.org/barf">barf</a>. <br> The <a href="https://git.btxx.org/barf">code for this site</a> is MIT. </small> diff --git a/build/index.html b/build/index.html index 10a7f83..b47b9af 100644 --- a/build/index.html +++ b/build/index.html @@ -39,6 +39,7 @@ <li><a href="https://git.btxx.org/barf">Source Code</a></li> </ul> <small> + Feeds: <a href="/atom.xml">Atom</a> | <a href="/rss.xml">RSS</a> <br> Built with <a href="https://git.btxx.org/barf">barf</a>. <br> The <a href="https://git.btxx.org/barf">code for this site</a> is MIT. </small> diff --git a/build/macos/index.html b/build/macos/index.html index 466f6bb..f3d1d74 100644 --- a/build/macos/index.html +++ b/build/macos/index.html @@ -43,6 +43,7 @@ sudo ln -fs /opt/homebrew/bin/gdate /usr/local/bin/date <li><a href="https://git.btxx.org/barf">Source Code</a></li> </ul> <small> + Feeds: <a href="/atom.xml">Atom</a> | <a href="/rss.xml">RSS</a> <br> Built with <a href="https://git.btxx.org/barf">barf</a>. <br> The <a href="https://git.btxx.org/barf">code for this site</a> is MIT. </small> diff --git a/build/markdown-examples/index.html b/build/markdown-examples/index.html index 94fe221..043a664 100644 --- a/build/markdown-examples/index.html +++ b/build/markdown-examples/index.html @@ -257,6 +257,7 @@ tags.</p> <li><a href="https://git.btxx.org/barf">Source Code</a></li> </ul> <small> + Feeds: <a href="/atom.xml">Atom</a> | <a href="/rss.xml">RSS</a> <br> Built with <a href="https://git.btxx.org/barf">barf</a>. <br> The <a href="https://git.btxx.org/barf">code for this site</a> is MIT. </small> diff --git a/build/openbsd/index.html b/build/openbsd/index.html index 1099502..7d75ce1 100644 --- a/build/openbsd/index.html +++ b/build/openbsd/index.html @@ -33,6 +33,7 @@ <li><a href="https://git.btxx.org/barf">Source Code</a></li> </ul> <small> + Feeds: <a href="/atom.xml">Atom</a> | <a href="/rss.xml">RSS</a> <br> Built with <a href="https://git.btxx.org/barf">barf</a>. <br> The <a href="https://git.btxx.org/barf">code for this site</a> is MIT. </small> diff --git a/build/rss.xml b/build/rss.xml new file mode 100644 index 0000000..065e51d --- /dev/null +++ b/build/rss.xml @@ -0,0 +1,332 @@ +<?xml version="1.0" encoding="utf-8"?> +<rss version="2.0"> + <channel> + <title>barf</title> + <link>/rss.xml</link> + <description>Feed description here</description> + <lastBuildDate>Thu, 06 Jun 2024 12:34:47 +0000</lastBuildDate> + <pubDate>Thu, 06 Jun 2024 12:34:47 +0000</pubDate> + <generator>Custom RSS Generator</generator> + <ttl>1800</ttl> + <item> + <title>Running `barf` on OpenBSD</title> + <description><![CDATA[<h1>Running <code>barf</code> on OpenBSD</h1> +<p>2023-08-12</p> +<p>The <code>barf</code> project was built on Linux and was catered towards Linux users. The core of the project will remain focused on Linux/GNU tools, but I also need to support OpenBSD since that is my personal operating system of choice.</p> +<h2>Download Packages</h2> +<p>Along with your Markdown parser of choice (<code>barf</code> assumes you will be using my version of <a href="https://git.sr.ht/~bt/smu">smu</a>) you will also need to install the required packages on your OpenBSD system:</p> +<pre><code>doas pkg_add rsync coreutils gsed cmake gcc +</code></pre> +<p>Then ensure that you alter all instances of <code>sed</code> with <code>gsed</code> in the core <code>barf</code> file. (Or make an alias if you'd prefer not to alter the main file)</p> +<p>After that, everything should work perfectly fine when building!</p>]]></description> + <link>/openbsd</link> + <guid isPermaLink="false">/openbsd</guid> + <pubDate>Sat, 12 Aug 2023 00:00:00 +0000</pubDate> + </item> + <item> + <title>Markdown Examples in barf</title> + <description>< +</code></pre> +<p>The resulting HTML-Code</p> +<pre><code>&lt;a href=&quot;http://s01.de/~gottox/index.cgi/proj_smu&quot;&gt;smu - simple mark up&lt;/a&gt;&lt;/p&gt; +</code></pre> +<h2>Lists</h2> +<p>Defining lists is very straightforward:</p> +<pre><code>* Item 1 +* Item 2 +* Item 3 +</code></pre> +<p>Result:</p> +<pre><code>&lt;ul&gt; +&lt;li&gt;Item 1&lt;/li&gt; +&lt;li&gt;Item 2&lt;/li&gt; +&lt;li&gt;Item 3&lt;/li&gt; +&lt;/ul&gt; +</code></pre> +<p>Defining ordered lists is also very easy:</p> +<pre><code>1. Item 1 +2. Item 2 +3. Item 3 +</code></pre> +<p>Only the first number in a list is meaningful. All following list items are +continously counted. If you want a list starting at 2, you could write:</p> +<pre><code>2. Item 1 +2. Item 2 +2. Item 3 +</code></pre> +<p>and get the following HTML which will render with the numbers 2, 3, 4:</p> +<pre><code>&lt;ol start=&quot;2&quot;&gt; +&lt;li&gt;Item 1&lt;/li&gt; +&lt;li&gt;Item 2&lt;/li&gt; +&lt;li&gt;Item 3&lt;/li&gt; +&lt;/ol&gt; +</code></pre> +<h2>Code &amp; Blockquote</h2> +<p>Use the <code>&gt; </code> as a line prefix for defining blockquotes. Blockquotes are +interpreted as well. This makes it possible to embed links, headings and even +other quotes into a quote:</p> +<pre><code>&gt; Hello +&gt; This is a quote with a [link](http://s01.de/~gottox) +</code></pre> +<p>Result: +</p> +<pre><code>&lt;blockquote&gt;&lt;p&gt; +Hello +This is a quote with a &lt;a href=&quot;http://s01.de/~gottox&quot;&gt;link&lt;/a&gt;&lt;/p&gt; +&lt;/blockquote&gt; +</code></pre> +<p>You can define a code block with a leading Tab or with <strong>4</strong> leading spaces</p> +<pre><code> this.is(code) + + this.is(code, too) +</code></pre> +<p>Result: +</p> +<pre><code>&lt;pre&gt;&lt;code&gt;this.is(code)&lt;/code&gt;&lt;/pre&gt; +&lt;pre&gt;&lt;code&gt;this.is(code, too) +&lt;/code&gt;&lt;/pre&gt; +</code></pre> +<p>Please note that you can't use HTML or smu syntax in a code block.</p> +<p>Another way to write code blocks is to use code fences:</p> +<pre><code>```json +{&quot;some&quot;: &quot;code&quot;} +``` +</code></pre> +<p>This has two advantages:</p> + +<ul> +<li>The optional language identifier will be turned into a <code>language-</code> class name</li> +<li>You can keep the original indentation which helps when doing copy &amp; paste</li> +</ul> +<h2>Tables</h2> +<p>Tables can be generated with the following syntax:</p> +<pre><code>| Heading1 | Heading2 | +| -------- | -------- | +| Cell 1 | Cell2 | +</code></pre> +<p>Aligning the columns make the input nicer to read, but is not necessary to get +correct table output. You could just write</p> +<pre><code>| Heading1 | Heading2 | +| --- | --- | +| Cell 1 | Cell2 | +</code></pre> +<p>To align the content of table cells, use <code>|:--|</code> for left, <code>|--:|</code> for right +and <code>|:--:|</code> for centered alignment in the row which separates the header from +the table body.</p> +<pre><code>| Heading1 | Heading2 | Heading3 | +| :------- | :------: | -------: | +| Left | Center | Right | +</code></pre> +<h2>Other interesting stuff</h2> +<ul> +<li><p>to insert a horizontal rule simple add <code>- - -</code> into an empty line:</p> +<pre><code>Hello +- - - +Hello2 +</code></pre> +<p>Result: +</p> +<pre><code>&lt;p&gt; +Hello +&lt;hr /&gt; +</code></pre> +<pre><code>Hello2&lt;/p&gt; +</code></pre> +</li> +<li><p>Any ASCII punctuation character may escaped by precedeing them with a +backslash to avoid them being interpreted:</p> +<pre><code>!&quot;#$%&amp;'()*+,-./:;&lt;=&gt;?@[]^_`{|}~\ +</code></pre> +</li> +<li><p>To force a linebreak simple add two spaces to the end of the line:</p> +<pre><code>No linebreak +here. +But here is +one. +</code></pre> +</li> +</ul> +<h2>embed HTML</h2> +<p>You can include arbitrary HTML code in your documents. The HTML will be +passed through to the resulting document without modification. This is a good +way to work around features that are missing in smu. If you don't want this +behaviour, use the <code>-n</code> flag when executing smu to stricly escape the HTML +tags.</p>]]></description> + <link>/markdown-examples</link> + <guid isPermaLink="false">/markdown-examples</guid> + <pubDate>Thu, 05 Jan 2023 00:00:00 +0000</pubDate> + </item> + <item> + <title>Running `barf` on MacOS</title> + <description><![CDATA[<h1>Running <code>barf</code> on MacOS</h1> +<p>2023-01-18</p> +<p>The <code>barf</code> project was built on Linux and was catered towards Linux users. The core of the project will remain focused on Linux/GNU tools, but that doesn't mean MacOS needs to be left out in the cold.</p> +<p>There are some very minor changes you'll need to make to your default <code>sed</code> and <code>date</code> paths if you plan to run barf on MacOS.</p> +<h2>Download Packages</h2> +<p>This walkthrough assumes that you already have <a href="https://brew.sh/">homebrew</a> installed on your machine.</p> +<p>You will need to install the GNU versions of both <code>date</code> and <code>sed</code> in order to avoid breaking things when <code>barf</code> tries to build.</p> +<pre><code>brew install coreutils +brew install gnu-sed +</code></pre> +<h2>Setting <code>gsed</code> and <code>gdate</code> as Default</h2> +<p>Now run the following in a terminal shell:</p> +<pre><code>sudo ln -fs /opt/homebrew/bin/gsed /usr/local/bin/sed +sudo ln -fs /opt/homebrew/bin/gdate /usr/local/bin/date +</code></pre> +<p>and add the following to your <code>.bash_profile</code> file:</p> +<pre><code>export PATH=&quot;/usr/local/bin:$PATH&quot; +</code></pre> +<p>Reload your <code>bash</code> instance and everything should work as intended!</p>]]></description> + <link>/macos</link> + <guid isPermaLink="false">/macos</guid> + <pubDate>Wed, 18 Jan 2023 00:00:00 +0000</pubDate> + </item> + <item> + <title>Supporting Basic Dark Mode</title> + <description><![CDATA[<h1>Supporting Basic Dark Mode</h1> +<p>2023-03-07</p> +<p>The default <code>barf</code> site generator now supports basic dark mode functionality. This has been achieved by including the standard <code>color-scheme</code> meta tag in the core <code>header.html</code> file:</p> +<pre><code>&lt;meta name=&quot;color-scheme&quot; content=&quot;dark light&quot;&gt; +</code></pre> +<p>This change also ships with some minor updates to the default <code>blockquote</code> design. You can see an example below:</p> +<blockquote><p>This is a really <em>cool</em> blockquote</p> +</blockquote> +<h2>Minor Caveat</h2> +<p>Unfortunately, Safari still has minor <code>ahref</code> / link color issue when defaulting to browser dark mode. If this is a problem for your own build of <code>barf</code>, take a look at a <a href="https://bt.ht/safari-default-dark-mode/">solution I wrote about here</a>.</p> +<p>Personally, I can't be bothered to add that extra code to this project. The Safari team needs to get their shit together and fix such a simple bug. Plus, you shouldn't be using Safari anyway - it's proprietary garbage.</p>]]></description> + <link>/dark-mode</link> + <guid isPermaLink="false">/dark-mode</guid> + <pubDate>Tue, 07 Mar 2023 00:00:00 +0000</pubDate> + </item> + <item> + <title>Cleaning Up barf's Structure</title> + <description><![CDATA[<h1>Cleaning Up barf's Structure</h1> +<p>2023-10-09</p> +<p>Things probably look a little different around here. Both in terms of this demo site <em>and</em> the core <code>barf</code> files itself.</p> +<p>This project was always intended to be focused on Linux platforms. So, I've removed the included <code>barf_macos</code> and <code>barf_openbsd</code> files to keep the generator more streamlined. But have no fear! Instructions for both Mac and OpenBSD can still be found on the main blog:</p> +<ul> +<li><a href="/macos">Running <code>barf</code> on MacOS</a></li> +<li><a href="/openbsd">Running <code>barf</code> on OpenBSD</a></li> +</ul> +<p>As for the "default" look of <code>barf</code>, I've simplified things further. The total CSS styling now consists of only:</p> +<pre><code>*{box-sizing:border-box;} +body{font-family:sans-serif;margin:0 auto;max-width:650px;padding:1rem;} +img{max-width:100%;} +pre{overflow:auto;} +</code></pre> +<p>Users still have the ability to tweak things as much as they'd like, but the standard look should be more than enough for anyone just focusing on writing. Dark mode has also been dropped but is easily added by adding the following inside the <code>head</code> tags:</p> +<pre><code>&lt;meta name=&quot;color-scheme&quot; content=&quot;dark light&quot;&gt; +</code></pre> +<p>Hopefully these changes reduce the overall scope of the project, which was a main point made on the README originally!</p>]]></description> + <link>/cleanup</link> + <guid isPermaLink="false">/cleanup</guid> + <pubDate>Mon, 09 Oct 2023 00:00:00 +0000</pubDate> + </item> +</channel> +</rss> diff --git a/build/websites/index.html b/build/websites/index.html index f2ba617..417afa5 100644 --- a/build/websites/index.html +++ b/build/websites/index.html @@ -32,6 +32,7 @@ <li><a href="https://git.btxx.org/barf">Source Code</a></li> </ul> <small> + Feeds: <a href="/atom.xml">Atom</a> | <a href="/rss.xml">RSS</a> <br> Built with <a href="https://git.btxx.org/barf">barf</a>. <br> The <a href="https://git.btxx.org/barf">code for this site</a> is MIT. </small> diff --git a/footer.html b/footer.html index 861f246..caef879 100644 --- a/footer.html +++ b/footer.html @@ -8,6 +8,7 @@ <li><a href="https://git.btxx.org/barf">Source Code</a></li> </ul> <small> + Feeds: <a href="/atom.xml">Atom</a> | <a href="/rss.xml">RSS</a> <br> Built with <a href="https://git.btxx.org/barf">barf</a>. <br> The <a href="https://git.btxx.org/barf">code for this site</a> is MIT. </small> |