About `barf`

barf is a minimal and suckless-inspired blog generator. It is a tweaked and slightly patched version of Karl Bartel’s fantastic blog.sh.

Why?

This project was created by me, Bradley Taunt, out of frustration with overly complex and bloated blogging options. I tried so many “minimal” generators but each one ended up having some glaring issue or heavy reliance on dependencies.

I wanted to have a system that I could easily replicate on any Linux machine. Something that didn’t require me to download half the internet just to get up and running. I’m a sucker for keeping things simple.

blob - 145d5a8e362b0adc8c5cb24347ccd519d5f2ab78 blob + a4148bfc18d0eedcaa354ed8d31b40d1fe1844f3 --- build/atom.xml +++ build/atom.xml @@ -2,34 +2,46 @@ barf - 2024-06-07T10:26:51Z + 2024-06-08T11:53:53Z - Bradley Taunt + https://barf.btxx.org,2024-01-19:default-atom-feed/ Quality of Life Improvements <h1 id="quality-of-life-improvements">Quality of Life Improvements</h1> + <p>2024-06-06</p> + <p>I haven’t circled back to <code>barf</code> in quite a bit of time, so I’m happy to announce a small update mainly focused on quality of life improvements! I’ll keep things brief and get right into the core changes:</p> + <p><strong>Automatic detection of your operating system (supports Linux, macOS and OpenBSD currently)</strong></p> + <ul> <li><code>barf</code> now checks your current OS and sets aliases accordingly</li> <li>this removes the need to hard-set your own aliases or run syslinks</li> </ul> + <p><strong>Added a semantically valid RSS feed</strong></p> + <ul> <li><code>barf</code> initially launched with Atom support only, now a separate RSS feed is generated at build time</li> </ul> + <p><strong>Removed hardcoded feed links from <code>header.html</code></strong></p> + <ul> <li>You now only need to set your main domain at the top of the core <code>barf</code> file.</li> </ul> + <p><strong>Swapped out <code>smu</code> for <code>lowdown</code></strong></p> + <ul> <li>The default Markdown parser is now set to <code>lowdown</code>. The original parser (<code>smu</code>) is great, but I wanted to make the project simpler by avoiding users to clone and build a separate package.</li> </ul> + <p>That’s it really! I’ve also updated the original blog posts about setting up <code>barf</code> on macOS and OpenBSD to reflect these changes.</p> + <p>Cheers!</p> https://barf.btxx.org/qol @@ -39,12 +51,18 @@ Running `barf` on OpenBSD <h1 id="running-on-openbsd">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 id="download-packages">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>After that, everything should work perfectly fine when building!</p> https://barf.btxx.org/openbsd @@ -54,12 +72,17 @@ Markdown Examples in barf <h1 id="markdown-examples-in-barf">Markdown Examples in barf</h1> + <p>2023-01-05</p> + <p>This following was lifted from <a href="https://github.com/karlb/smu">https://github.com/karlb/smu</a></p> + <h1 id="syntax"><code>smu</code> Syntax</h1> + <p>smu was started as a rewrite of <a href="http://daringfireball.net/projects/markdown/">markdown</a> but became something more lightweight and consistent. It differs from <a href="https://commonmark.org/">CommonMark</a> in the following ways:</p> + <ul> <li>No support for <em>reference style links</em></li> <li>Stricter indentation rules for lists</li> @@ -67,13 +90,17 @@ more lightweight and consistent. It differs from <a <li>Horizontal rules (<code><hr></code>) must use <code>- - -</code> as syntax</li> <li>Code fences have stricter syntax</li> </ul> + <p>Patches that increase the CommonMark compatibility are welcome as long as they don’t increase the code complexity significantly.</p> + <p>This project is a fork of the <a href="https://github.com/gottox/smu">original smu</a> by <a href="https://eboland.de">Enno Boland (gottox)</a>. The main differences to the original smu are:</p> + <ul> <li>Support for code fences</li> <li>Improved <a href="https://commonmark.org/">CommonMark</a> compatibility. E.g. + <ul> <li>Code blocks need four spaces indentation instead of three</li> <li>Skip empty lines at end of code blocks</li> @@ -87,10 +114,14 @@ original smu are:</p> </ul></li> <li>Added a simple test suite to check for compliance and avoid regressions</li> </ul> + <h2 id="inline-patterns">Inline patterns</h2> + <p>There are several patterns you can use to highlight your text:</p> + <ul> -<li><p>Emphasis +<li><p>Emphasis</p> + <ul> <li>Surround your text with <code>*</code> or <code>_</code> to get <em>emphasised</em> text: This <em>is</em> cool. @@ -106,29 +137,39 @@ This <strong><em>is</em></strong& This is a wontfix bug because it would make the source too complex. Use this instead: <strong><em>Hello</em></strong> <em>you</em></li> -</ul></p></li> +</ul></li> <li><p>inline Code</p> + <p>You can produce inline code by surrounding it with backticks.</p> + <p>Use <code>rm -rf /</code> if you’re a N00b. Use <code>rm -rf /</code> if you’re a N00b. Use <code>rm -rf /</code> if you’re a N00b.</p> + <p>Double and triple backticks can be used if the code itself contains backticks.</p></li> </ul> + <h2 id="titles">Titles</h2> + <p>Creating titles in smu is very easy. There are two different syntax styles. The first is underlining with at least three characters:</p> + <pre><code>Heading ======= Topic ----- </code></pre> + <p>This is very intuitive and self explaining. The resulting sourcecode looks like this:</p> + <pre><code><h1>Heading</h1> <h2>Topic</h2> </code></pre> + <p>Use the following prefixes if you don’t like underlining:</p> + <pre><code># h1 ## h2 ### h3 @@ -136,127 +177,179 @@ this:</p> ##### h5 ###### h6 </code></pre> + <h2 id="links">Links</h2> + <p>The simplest way to define a link is with simple <code><></code>.</p> + <pre><code><http://s01.de> </code></pre> + <p>You can do the same for E-Mail addresses:</p> + <pre><code><yourname@s01.de> </code></pre> + <p>If you want to define a label for the url, you have to use a different syntax</p> + <pre><code>[smu - simple mark up](http://s01.de/~gottox/index.cgi/proj_smu) </code></pre> + <p>The resulting HTML-Code</p> + <pre><code><a href="http://s01.de/~gottox/index.cgi/proj_smu">smu - simple mark up</a></p> </code></pre> + <h2 id="lists">Lists</h2> + <p>Defining lists is very straightforward:</p> + <pre><code>* Item 1 * Item 2 * Item 3 </code></pre> + <p>Result:</p> + <pre><code><ul> <li>Item 1</li> <li>Item 2</li> <li>Item 3</li> </ul> </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><ol start="2"> <li>Item 1</li> <li>Item 2</li> <li>Item 3</li> </ol> </code></pre> + <h2 id="code-blockquote">Code & Blockquote</h2> + <p>Use the <code>></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>> Hello > This is a quote with a [link](http://s01.de/~gottox) </code></pre> + <p>Result: Hello This is a quote with a link </p> + <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: this.is(code) this.is(code, too) </p> + <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 {"some": "code"} ``` </code></pre> + <p>This has two advantages: * The optional language identifier will be turned into a <code>language-</code> class name * You can keep the original indentation which helps when doing copy & paste</p> + <h2 id="tables">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 id="footnotes">Footnotes</h2> + <p>Here is an example of using Markdown footnotes<sup id="fnref1"><a href="#fn1" rel="footnote">1</a></sup>. And incase you were looking for more examples, here is another one<sup id="fnref2"><a href="#fn2" rel="footnote">2</a></sup>.</p> + <h2 id="other-interesting-stuff">Other interesting stuff</h2> + <ul> <li><p>to insert a horizontal rule simple add <code>- - -</code> into an empty line:</p> + <p>Hello</p> + <hr/> + <p>Hello2</p> + <p>Result: Hello </p> + <p>Hello2</p></li> <li><p>Any ASCII punctuation character may escaped by precedeing them with a backslash to avoid them being interpreted:</p> -<p>!”#$%&’()*+,-./:;<=>?@[]^_`{|}~\</p></li> + +<p>!”#$%&’()*+,-./:;<=>?@[]<sup>_`{|}~\</sup></p></li> <li><p>To force a linebreak simple add two spaces to the end of the line:</p> + <p>No linebreak here. But here is<br/> one.</p></li> </ul> + <h2 id="embed-html">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> + <div class="footnotes"> <hr/> <ol> @@ -279,14 +372,21 @@ tags.</p> Running `barf` on MacOS <h1 id="running-on-macos">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> + <h2 id="download-packages">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> + <p>Now everything should work as intended!</p> https://barf.btxx.org/macos @@ -296,16 +396,24 @@ brew install gnu-sed Supporting Basic Dark Mode <h1 id="supporting-basic-dark-mode">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><meta name="color-scheme" content="dark light"> </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 id="minor-caveat">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> https://barf.btxx.org/dark-mode @@ -315,22 +423,31 @@ brew install gnu-sed Cleaning Up barf's Structure <h1 id="cleaning-up-barfs-structure">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><meta name="color-scheme" content="dark light"> </code></pre> + <p>Hopefully these changes reduce the overall scope of the project, which was a main point made on the README originally!</p> https://barf.btxx.org/cleanup blob - b567bacaa6d411af5e716c6bc3a5bd3fc30a57c8 blob + b34599bab1c11c573297a24973d2374373adb8e0 --- build/cleanup/index.html +++ build/cleanup/index.html @@ -16,22 +16,31 @@

Cleaning Up barf’s Structure

2023-10-09

Things probably look a little different around here. Both in terms of this demo site and the core barf files itself.

This project was always intended to be focused on Linux platforms. So, I’ve removed the included barf_macos and barf_openbsd 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:

As for the “default” look of barf, I’ve simplified things further. The total CSS styling now consists of only:

*{box-sizing:border-box;}
 body{font-family:sans-serif;margin:0 auto;max-width:650px;padding:1rem;}
 img{max-width:100%;}
 pre{overflow:auto;}

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 head tags:

<meta name="color-scheme" content="dark light">

Hopefully these changes reduce the overall scope of the project, which was a main point made on the README originally!

blob - 02c75f04f73f234b72069561cd73cdffd2e1aaf0 blob + 1e4d1830fa31bbce43891dd0f2676313eb0f839b --- build/dark-mode/index.html +++ build/dark-mode/index.html @@ -16,16 +16,24 @@

Supporting Basic Dark Mode

2023-03-07

The default barf site generator now supports basic dark mode functionality. This has been achieved by including the standard color-scheme meta tag in the core header.html file:

<meta name="color-scheme" content="dark light">

This change also ships with some minor updates to the default blockquote design. You can see an example below:

This is a really cool blockquote

Minor Caveat

Unfortunately, Safari still has minor ahref / link color issue when defaulting to browser dark mode. If this is a problem for your own build of barf, take a look at a solution I wrote about here.

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.

blob - c04b05b430717ede45bf09aa5dd3e40279a26baf blob + 69197cdab3b6b467111468485a22b9438eeadb3f --- build/index.html +++ build/index.html @@ -16,33 +16,52 @@

barf

barf is an extremely minimal blog generator.

The entire build script is >170 lines of shell.

It could almost be called “suckless”, but probably isn’t. It was created for those focused on writing, not tinkering.

You can learn more by reading the official README.

barf = blogs are really fun

Get setup in 2 minutes

Install dependencies:

For Linux (Alpine example):

sudo apk add rsync lowdown

For macOS:

brew install rsync lowdown coreutils gnu-sed

For OpenBSD:

doas pkg_add rsync lowdown coreutils gsed cmake gcc
+
+doas pkg_add lowdown coreutils gsed cmake gcc
 
+
 Clone barf: 
+
 git clone https://git.btxx.org/barf
 
+
 
 Open project, change the domain variable at the top of the core barf file
 Run: make build
 Upload the contents of build to your server! 
 Profit?
 
+
 
+
 Articles
 
 2024-06-06 · Quality of Life Improvements
blob - 40ed9a86417be7e06006559db73ce701ce417369
blob + 34bbee17c56ef0cdca053f063b0fa77a009d5197
--- build/macos/index.html
+++ build/macos/index.html
@@ -16,14 +16,21 @@
 
 
 Running barf on MacOS
+
 2023-01-18
+
 The barf 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.
+
 Download Packages
+
 This walkthrough assumes that you already have homebrew installed on your machine.
+
 You will need to install the GNU versions of both date and sed in order to avoid breaking things when barf tries to build.
+
 brew install coreutils
 brew install gnu-sed
 
+
 Now everything should work as intended!
 
     
blob - 44f972e00fad20b8dd9e75e2cf489ac28754c554
blob + 25683ea8d0248a1d6699aa81dd9dfca301a83b93
--- build/markdown-examples/index.html
+++ build/markdown-examples/index.html
@@ -16,12 +16,17 @@
 
 
 Markdown Examples in barf
+
 2023-01-05
+
 This following was lifted from https://github.com/karlb/smu
+
 smu Syntax
+
 smu was started as a rewrite of
 markdown but became something
 more lightweight and consistent. It differs from CommonMark in the following ways:
+
 
 No support for reference style links
 Stricter indentation rules for lists
@@ -29,13 +34,17 @@ more lightweight and consistent. It differs from Horizontal rules (<hr>) must use - - - as syntax
 Code fences have stricter syntax
 

+
 Patches that increase the CommonMark compatibility are welcome as long as they don’t increase the code complexity significantly.
+
 This project is a fork of the original smu by
 Enno Boland (gottox). The main differences to the
 original smu are:
+
 
 Support for code fences
 Improved CommonMark compatibility. E.g.
+
 
 Code blocks need four spaces indentation instead of three
 Skip empty lines at end of code blocks
@@ -49,10 +58,14 @@ original smu are:
 
 Added a simple test suite to check for compliance and avoid regressions
 
+
 Inline patterns
+
 There are several patterns you can use to highlight your text:
+
 
-Emphasis
+
Emphasis
+
 
 Surround your text with * or _ to get emphasised text:
 This is cool.
@@ -68,29 +81,39 @@ This is cool, too.
 This is a wontfix bug because it would make the source too complex.
 Use this instead:
 Hello you
-

+
 inline Code
+
 You can produce inline code by surrounding it with backticks.
+
 Use rm -rf / if you’re a N00b.
 Use rm -rf / if you’re a N00b.
 Use rm -rf / if you’re a N00b.
+
 Double and triple backticks can be used if the code itself contains backticks.
 
+
 Titles
+
 Creating titles in smu is very easy. There are two different syntax styles. The
 first is underlining with at least three characters:
+
 Heading
 =======
 
 Topic
 -----
 
+
 This is very intuitive and self explaining. The resulting sourcecode looks like
 this:
+
 <h1>Heading</h1>
 <h2>Topic</h2>
 
+
 Use the following prefixes if you don’t like underlining:
+
 # h1
 ## h2
 ### h3
@@ -98,127 +121,179 @@ this:
 ##### h5
 ###### h6
 
+
 Links
+
 The simplest way to define a link is with simple <>.
+
 <http://s01.de>
 
+
 You can do the same for E-Mail addresses:
+
 <yourname@s01.de>
 
+
 If you want to define a label for the url, you have to use a different syntax
+
 [smu - simple mark up](http://s01.de/~gottox/index.cgi/proj_smu)
 
+
 The resulting HTML-Code
+
 <a href="http://s01.de/~gottox/index.cgi/proj_smu">smu - simple mark up</a></p>
 
+
 Lists
+
 Defining lists is very straightforward:
+
 * Item 1
 * Item 2
 * Item 3
 
+
 Result:
+
 <ul>
 <li>Item 1</li>
 <li>Item 2</li>
 <li>Item 3</li>
 </ul>
 
+
 Defining ordered lists is also very easy:
+
 1. Item 1
 2. Item 2
 3. Item 3
 
+
 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:
+
 2. Item 1
 2. Item 2
 2. Item 3
 
+
 and get the following HTML which will render with the numbers 2, 3, 4:
+
 <ol start="2">
 <li>Item 1</li>
 <li>Item 2</li>
 <li>Item 3</li>
 </ol>
 
+
 Code & Blockquote
+
 Use the > 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:
+
 > Hello
 > This is a quote with a [link](http://s01.de/~gottox)
 
+
 Result:
     
     Hello
     This is a quote with a link
     
+
 You can define a code block with a leading Tab or with 4 leading spaces
+
     this.is(code)
 
     this.is(code, too)
 
+
 Result:
     this.is(code)
     this.is(code, too)
     
+
 Please note that you can’t use HTML or smu syntax in a code block.
+
 Another way to write code blocks is to use code fences:
+
 ```json
 {"some": "code"}
 ```
 
+
 This has two advantages:
 * The optional language identifier will be turned into a language- class name
 * You can keep the original indentation which helps when doing copy & paste
+
 Tables
+
 Tables can be generated with the following syntax:
+
 | Heading1 | Heading2 |
 | -------- | -------- |
 | Cell 1   | Cell2    |
 
+
 Aligning the columns make the input nicer to read, but is not necessary to get
 correct table output. You could just write
+
 | Heading1 | Heading2 |
 | --- | --- |
 | Cell 1 | Cell2 |
 
+
 To align the content of table cells, use |:--| for left, |--:| for right
 and |:--:| for centered alignment in the row which separates the header from
 the table body.
+
 | Heading1 | Heading2 | Heading3 |
 | :------- | :------: | -------: |
 | Left     | Center   | Right    |
 
+
 Footnotes
+
 Here is an example of using Markdown footnotes¹. And incase you were looking for more examples, here is another one².
+
 Other interesting stuff
+
 
 to insert a horizontal rule simple add - - - into an empty line:
+
 Hello
+
 
+
 Hello2
+
 Result:
 
 Hello
 
+
 Hello2
 Any ASCII punctuation character may escaped by precedeing them with a
 backslash to avoid them being interpreted:
-!”#$%&’()*+,-./:;<=>?@[]^_`{|}~\
+
+!”#$%&’()*+,-./:;<=>?@[]^_`{|}~\
 To force a linebreak simple add two spaces to the end of the line:
+
 No linebreak
 here.
 But here is

 one.
 
+
 embed HTML
+
 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 -n flag when executing smu to stricly escape the HTML
 tags.
+
 
 
 
blob - 999917a8aed7293b7bbc5009d5115dbca0cb3006
blob + 5cb759d6eac4baf2f112ac9a8e1ab411efdc743e
--- build/openbsd/index.html
+++ build/openbsd/index.html
@@ -16,12 +16,18 @@
 
 
 Running barf on OpenBSD
+
 2023-08-12
+
 The barf 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.
+
 Download Packages
+
 Along with your Markdown parser of choice (barf assumes you will be using my version of smu) you will also need to install the required packages on your OpenBSD system:
+
 doas pkg_add rsync coreutils gsed cmake gcc
 
+
 After that, everything should work perfectly fine when building!
 
     
blob - bf38b428d5b4f1b5517f90d89407c77bda51e623
blob + d76dc55c5a7aae8179f03bd50f52bfeb31164044
--- build/qol/index.html
+++ build/qol/index.html
@@ -16,26 +16,38 @@
 
 
 Quality of Life Improvements
+
 2024-06-06
+
 I haven’t circled back to barf in quite a bit of time, so I’m happy to announce a small update mainly focused on quality of life improvements! I’ll keep things brief and get right into the core changes:
+
 Automatic detection of your operating system (supports Linux, macOS and OpenBSD currently)
+
 
 barf now checks your current OS and sets aliases accordingly
 this removes the need to hard-set your own aliases or run syslinks
 
+
 Added a semantically valid RSS feed
+
 
 barf initially launched with Atom support only, now a separate RSS feed is generated at build time
 
+
 Removed hardcoded feed links from header.html
+
 
 You now only need to set your main domain at the top of the core barf file.
 
+
 Swapped out smu for lowdown
+
 
 The default Markdown parser is now set to lowdown. The original parser (smu) is great, but I wanted to make the project simpler by avoiding users to clone and build a separate package.
 
+
 That’s it really! I’ve also updated the original blog posts about setting up barf on macOS and OpenBSD to reflect these changes.
+
 Cheers!
 
     
blob - ed78ca1c0bff0ed1cea5b4889ca29f5297687cd3
blob + b583e2dfbc4a784a1c75ffae5663a6cd68a29a02
--- build/rss.xml
+++ build/rss.xml
@@ -4,33 +4,45 @@
 		barf
 		https://barf.btxx.org/rss.xml
 		Feed description here
-		Fri, 07 Jun 2024 14:26:51 +0000
-		Fri, 07 Jun 2024 14:26:51 +0000
+		Sat, 08 Jun 2024 15:53:53 +0000
+		Sat, 08 Jun 2024 15:53:53 +0000
 		Custom RSS Generator
 		1800
 		
 			Quality of Life Improvements
 			<h1 id="quality-of-life-improvements">Quality of Life Improvements</h1>
+
 <p>2024-06-06</p>
+
 <p>I haven&#8217;t circled back to <code>barf</code> in quite a bit of time, so I&#8217;m happy to announce a small update mainly focused on quality of life improvements! I&#8217;ll keep things brief and get right into the core changes:</p>
+
 <p><strong>Automatic detection of your operating system (supports Linux, macOS and OpenBSD currently)</strong></p>
+
 <ul>
 <li><code>barf</code> now checks your current OS and sets aliases accordingly</li>
 <li>this removes the need to hard-set your own aliases or run syslinks</li>
 </ul>
+
 <p><strong>Added a semantically valid RSS feed</strong></p>
+
 <ul>
 <li><code>barf</code> initially launched with Atom support only, now a separate RSS feed is generated at build time</li>
 </ul>
+
 <p><strong>Removed hardcoded feed links from <code>header.html</code></strong></p>
+
 <ul>
 <li>You now only need to set your main domain at the top of the core <code>barf</code> file.</li>
 </ul>
+
 <p><strong>Swapped out <code>smu</code> for <code>lowdown</code></strong></p>
+
 <ul>
 <li>The default Markdown parser is now set to <code>lowdown</code>. The original parser (<code>smu</code>) is great, but I wanted to make the project simpler by avoiding users to clone and build a separate package.</li>
 </ul>
+
 <p>That&#8217;s it really! I&#8217;ve also updated the original blog posts about setting up <code>barf</code> on macOS and OpenBSD to reflect these changes.</p>
+
 <p>Cheers!</p>
 			https://barf.btxx.org/qol
 			https://barf.btxx.org/qol
@@ -39,12 +51,18 @@
 		
 			Running `barf` on OpenBSD
 			<h1 id="running-on-openbsd">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&#47;GNU tools, but I also need to support OpenBSD since that is my personal operating system of choice.</p>
+
 <h2 id="download-packages">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>After that, everything should work perfectly fine when building!</p>
 			https://barf.btxx.org/openbsd
 			https://barf.btxx.org/openbsd
@@ -53,12 +71,17 @@
 		
 			Markdown Examples in barf
 			<h1 id="markdown-examples-in-barf">Markdown Examples in barf</h1>
+
 <p>2023-01-05</p>
+
 <p>This following was lifted from <a href="https://github.com/karlb/smu">https:&#47;&#47;github.com&#47;karlb&#47;smu</a></p>
+
 <h1 id="syntax"><code>smu</code> Syntax</h1>
+
 <p>smu was started as a rewrite of
 <a href="http://daringfireball.net/projects/markdown/">markdown</a> but became something
 more lightweight and consistent. It differs from <a href="https://commonmark.org/">CommonMark</a> in the following ways:</p>
+
 <ul>
 <li>No support for <em>reference style links</em></li>
 <li>Stricter indentation rules for lists</li>
@@ -66,13 +89,17 @@ more lightweight and consistent. It differs from <a
 <li>Horizontal rules (<code>&#60;hr&#62;</code>) must use <code>- - -</code> as syntax</li>
 <li>Code fences have stricter syntax</li>
 </ul>
+
 <p>Patches that increase the CommonMark compatibility are welcome as long as they don&#8217;t increase the code complexity significantly.</p>
+
 <p>This project is a fork of the <a href="https://github.com/gottox/smu">original smu</a> by
 <a href="https://eboland.de">Enno Boland (gottox)</a>. The main differences to the
 original smu are:</p>
+
 <ul>
 <li>Support for code fences</li>
 <li>Improved <a href="https://commonmark.org/">CommonMark</a> compatibility. E.g.
+
 <ul>
 <li>Code blocks need four spaces indentation instead of three</li>
 <li>Skip empty lines at end of code blocks</li>
@@ -86,10 +113,14 @@ original smu are:</p>
 </ul></li>
 <li>Added a simple test suite to check for compliance and avoid regressions</li>
 </ul>
+
 <h2 id="inline-patterns">Inline patterns</h2>
+
 <p>There are several patterns you can use to highlight your text:</p>
+
 <ul>
-<li><p>Emphasis
+<li><p>Emphasis</p>
+
 <ul>
 <li>Surround your text with <code>*</code> or <code>_</code> to get <em>emphasised</em> text:
 This <em>is</em> cool.
@@ -105,29 +136,39 @@ This <strong><em>is</em></strong&
 This is a wontfix bug because it would make the source too complex.
 Use this instead:
 <strong><em>Hello</em></strong> <em>you</em></li>
-</ul></p></li>
+</ul></li>
 <li><p>inline Code</p>
+
 <p>You can produce inline code by surrounding it with backticks.</p>
+
 <p>Use <code>rm -rf &#47;</code> if you&#8217;re a N00b.
 Use <code>rm -rf &#47;</code> if you&#8217;re a N00b.
 Use <code>rm -rf &#47;</code> if you&#8217;re a N00b.</p>
+
 <p>Double and triple backticks can be used if the code itself contains backticks.</p></li>
 </ul>
+
 <h2 id="titles">Titles</h2>
+
 <p>Creating titles in smu is very easy. There are two different syntax styles. The
 first is underlining with at least three characters:</p>
+
 <pre><code>Heading
 =======
 
 Topic
 -----
 </code></pre>
+
 <p>This is very intuitive and self explaining. The resulting sourcecode looks like
 this:</p>
+
 <pre><code>&#60;h1&#62;Heading&#60;&#47;h1&#62;
 &#60;h2&#62;Topic&#60;&#47;h2&#62;
 </code></pre>
+
 <p>Use the following prefixes if you don&#8217;t like underlining:</p>
+
 <pre><code># h1
 ## h2
 ### h3
@@ -135,127 +176,179 @@ this:</p>
 ##### h5
 ###### h6
 </code></pre>
+
 <h2 id="links">Links</h2>
+
 <p>The simplest way to define a link is with simple <code>&#60;&#62;</code>.</p>
+
 <pre><code>&#60;http:&#47;&#47;s01.de&#62;
 </code></pre>
+
 <p>You can do the same for E-Mail addresses:</p>
+
 <pre><code>&#60;yourname@s01.de&#62;
 </code></pre>
+
 <p>If you want to define a label for the url, you have to use a different syntax</p>
+
 <pre><code>[smu - simple mark up](http:&#47;&#47;s01.de&#47;~gottox&#47;index.cgi&#47;proj_smu)
 </code></pre>
+
 <p>The resulting HTML-Code</p>
+
 <pre><code>&#60;a href="http:&#47;&#47;s01.de&#47;~gottox&#47;index.cgi&#47;proj_smu"&#62;smu - simple mark up&#60;&#47;a&#62;&#60;&#47;p&#62;
 </code></pre>
+
 <h2 id="lists">Lists</h2>
+
 <p>Defining lists is very straightforward:</p>
+
 <pre><code>* Item 1
 * Item 2
 * Item 3
 </code></pre>
+
 <p>Result:</p>
+
 <pre><code>&#60;ul&#62;
 &#60;li&#62;Item 1&#60;&#47;li&#62;
 &#60;li&#62;Item 2&#60;&#47;li&#62;
 &#60;li&#62;Item 3&#60;&#47;li&#62;
 &#60;&#47;ul&#62;
 </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>&#60;ol start="2"&#62;
 &#60;li&#62;Item 1&#60;&#47;li&#62;
 &#60;li&#62;Item 2&#60;&#47;li&#62;
 &#60;li&#62;Item 3&#60;&#47;li&#62;
 &#60;&#47;ol&#62;
 </code></pre>
+
 <h2 id="code-blockquote">Code &#38; Blockquote</h2>
+
 <p>Use the <code>&#62;</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>&#62; Hello
 &#62; This is a quote with a [link](http:&#47;&#47;s01.de&#47;~gottox)
 </code></pre>
+
 <p>Result:
     
     Hello
     This is a quote with a link
     </p>
+
 <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:
     this.is(code)
     this.is(code, too)
     </p>
+
 <p>Please note that you can&#8217;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
 {"some": "code"}
 ```
 </code></pre>
+
 <p>This has two advantages:
 * The optional language identifier will be turned into a <code>language-</code> class name
 * You can keep the original indentation which helps when doing copy &#38; paste</p>
+
 <h2 id="tables">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 id="footnotes">Footnotes</h2>
+
 <p>Here is an example of using Markdown footnotes<sup id="fnref1"><a href="#fn1" rel="footnote">1</a></sup>. And incase you were looking for more examples, here is another one<sup id="fnref2"><a href="#fn2" rel="footnote">2</a></sup>.</p>
+
 <h2 id="other-interesting-stuff">Other interesting stuff</h2>
+
 <ul>
 <li><p>to insert a horizontal rule simple add <code>- - -</code> into an empty line:</p>
+
 <p>Hello</p>
+
 <hr/>
+
 <p>Hello2</p>
+
 <p>Result:
 
 Hello
 </p>
+
 <p>Hello2</p></li>
 <li><p>Any ASCII punctuation character may escaped by precedeing them with a
 backslash to avoid them being interpreted:</p>
-<p>!&#8221;#$%&#38;&#8217;()*+,-.&#47;:;&#60;=&#62;?@[]^_`{|}~\</p></li>
+
+<p>!&#8221;#$%&#38;&#8217;()*+,-.&#47;:;&#60;=&#62;?@[]<sup>_`{|}~\</sup></p></li>
 <li><p>To force a linebreak simple add two spaces to the end of the line:</p>
+
 <p>No linebreak
 here.
 But here is<br/>
 one.</p></li>
 </ul>
+
 <h2 id="embed-html">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&#8217;t want this
 behaviour, use the <code>-n</code> flag when executing smu to stricly escape the HTML
 tags.</p>
+
 <div class="footnotes">
 <hr/>
 <ol>
@@ -277,14 +370,21 @@ tags.</p>
 		
 			Running `barf` on MacOS
 			<h1 id="running-on-macos">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&#47;GNU tools, but that doesn&#8217;t mean MacOS needs to be left out in the cold.</p>
+
 <h2 id="download-packages">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>
+
 <p>Now everything should work as intended!</p>
 			https://barf.btxx.org/macos
 			https://barf.btxx.org/macos
@@ -293,16 +393,24 @@ brew install gnu-sed
 		
 			Supporting Basic Dark Mode
 			<h1 id="supporting-basic-dark-mode">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>&#60;meta name="color-scheme" content="dark light"&#62;
 </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 id="minor-caveat">Minor Caveat</h2>
+
 <p>Unfortunately, Safari still has minor <code>ahref</code> &#47; 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&#8217;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&#8217;t be using Safari anyway - it&#8217;s proprietary garbage.</p>
 			https://barf.btxx.org/dark-mode
 			https://barf.btxx.org/dark-mode
@@ -311,22 +419,31 @@ brew install gnu-sed
 		
 			Cleaning Up barf's Structure
 			<h1 id="cleaning-up-barfs-structure">Cleaning Up barf&#8217;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&#8217;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 &#8220;default&#8221; look of <code>barf</code>, I&#8217;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&#8217;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>&#60;meta name="color-scheme" content="dark light"&#62;
 </code></pre>
+
 <p>Hopefully these changes reduce the overall scope of the project, which was a main point made on the README originally!</p>
 			https://barf.btxx.org/cleanup
 			https://barf.btxx.org/cleanup
blob - 8a06384f9340a76130b96528183ea9d15940e798
blob + f283b5572a5599a59eded84c3f0456d938dd6428
--- build/websites/index.html
+++ build/websites/index.html
@@ -16,7 +16,9 @@
 
 
 Websites Built with barf
+
 Send an email to bt [at] btxx [dot] org if you would like me to add your barf-generated website to this list.
+
 
 jsfree.org
 barf.btxx.org
blob - ea67516dcafc91322524fd3d7550421f941e8b96
blob + 92e98a2aeac2064c723aadb88ed8ea03a93fdfc5
--- index.md
+++ index.md
@@ -26,7 +26,7 @@ For macOS:
 
 For OpenBSD:
 
-    doas pkg_add rsync lowdown coreutils gsed cmake gcc
+    doas pkg_add lowdown coreutils gsed cmake gcc
 
 **Clone barf:**

About barf

Why?

Cleaning Up barf’s Structure

Websites Built with barf

About `barf`

Websites Built with `barf`