diff options
| author | Bradley Taunt <bt@btxx.org> | 2024-06-07 10:27:38 -0400 |
|---|---|---|
| committer | Bradley Taunt <bt@btxx.org> | 2024-06-07 10:27:38 -0400 |
| commit | 8a3e4e5207f59d42bfd6075e3792267266c86e71 (patch) | |
| tree | f54d760781244072ff66564b011fef18dbf4a3de | |
| parent | 8c47200dd81639b7cb1a3a165f4bb2eec2517970 (diff) | |
Homepage changes, README updates, swap to lowdown, cleanup
| -rw-r--r-- | README.md | 34 | ||||
| -rwxr-xr-x | barf | 2 | ||||
| -rw-r--r-- | build/about/index.html | 12 | ||||
| -rw-r--r-- | build/atom.xml | 254 | ||||
| -rw-r--r-- | build/cleanup/index.html | 12 | ||||
| -rw-r--r-- | build/dark-mode/index.html | 15 | ||||
| -rw-r--r-- | build/index.html | 47 | ||||
| -rw-r--r-- | build/macos/index.html | 8 | ||||
| -rw-r--r-- | build/markdown-examples/index.html | 205 | ||||
| -rw-r--r-- | build/openbsd/index.html | 8 | ||||
| -rw-r--r-- | build/qol/index.html | 12 | ||||
| -rw-r--r-- | build/rss.xml | 254 | ||||
| -rw-r--r-- | build/websites/index.html | 4 | ||||
| -rw-r--r-- | header.html | 2 | ||||
| -rw-r--r-- | index.md | 26 | ||||
| -rw-r--r-- | posts/markdown-examples.md | 8 | ||||
| -rw-r--r-- | posts/qol.md | 4 |
17 files changed, 445 insertions, 462 deletions
@@ -3,12 +3,11 @@ barf barf is an extremely minimal blog generator. -The entire build script is less than 100 lines of shell. +The entire build script is >170 lines of shell. It could *almost* be called "suckless", but probably isn't. -(barf is a modified/forked version of Karl Bartel's fantastic blog.sh -(https://github.com/karlb/karl.berlin). Be sure to check it out since +(barf is a modified/forked version of Karl Bartel's fantastic [blog.sh](https://github.com/karlb/karl.berlin). Be sure to check it out since my version does things slightly different.) You can see a [live demo here](https://barf.btxx.org) @@ -39,10 +38,14 @@ linux ----- - rsync -- smu (see below) +- lowdown - entr (optonal) - standard UNIX tools +Example on Alpine: + + sudo apk add rsync lowdown + openbsd ------- @@ -53,10 +56,12 @@ https://barf.btxx.org/openbsd - gcc - cmake - rsync +- lowdown - gsed -- smu (see below) - entr (optional) + doas pkg_add coreutils gcc cmake rsync lowdown gsed + macOS ----- @@ -66,9 +71,11 @@ https://barf.btxx.org/macos - coreutils - gnu-sed - rsync -- smu (see below) +- lowdown - entr (optional) + brew install coreutils gnu-sed rsync lowdown + basic setup ----------- @@ -77,14 +84,7 @@ and "footer.html" files with your own information, navigation, etc. Be sure to edit the **domain** variable inside `barf` or else your feed won't validate! -Then, clone and build my patched version of smu: - - git clone https://git.btxx.org/smu - cd smu - # OpenBSD users: change sudo to doas - sudo make install - -Then clone this directory and build: +Then build: make build @@ -155,11 +155,11 @@ or even speed things up are more than welcome! ## Can I use other Markdown parsers? -Of course! Simply edit the main `barf` script and swap out `smu` with +Of course! Simply edit the main `barf` script and swap out `lowdown` with something else. I wouldn't advise doing this if you already have pre-existing -content based-off `smu`, since this could break some of your pages. +content based-off `lowdown`, since this could break some of your pages. -But give smu (https://git.btxx.org/smu) a try - it is very lightweight and fast! +But give `lowdown` a try - it is very lightweight and fast! MORE FAQs TO COME... @@ -14,7 +14,7 @@ elif [ "$os_name" = "Darwin" ]; then fi set -eu -MARKDOWN=smu +MARKDOWN=lowdown IFS=' ' # Create tab separated file with filename, title, creation date, last update diff --git a/build/about/index.html b/build/about/index.html index fac6c41..698aa5c 100644 --- a/build/about/index.html +++ b/build/about/index.html @@ -7,7 +7,7 @@ <title>About `barf`</title> <link href="/atom.xml" type="application/atom+xml" rel="alternate" title="Atom feed for blog posts" /> <link href="/rss.xml" type="application/rss+xml" rel="alternate" title="RSS feed for blog posts" /> - <style>*{box-sizing:border-box;}body{font-family:sans-serif;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{overflow:auto;}</style> + <style>*{box-sizing:border-box;}body{font-family:sans-serif;line-height:1.33;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{border:1px solid;overflow:auto;padding:5px;}.footnotes{font-size:90%;}</style> </head> <nav> @@ -15,11 +15,11 @@ </nav> <main> -<h1>About <code>barf</code></h1> -<p>barf is a minimal and suckless-inspired blog generator. It is a tweaked and slightly patched version of Karl Bartel's fantastic <a href="https://github.com/karlb/karl.berlin">blog.sh</a>.</p> -<h2>Why?</h2> -<p>This project was created by me, <a href="https://btxx.org">Bradley Taunt</a>, out of frustration with overly complex and bloated blogging options. I tried <em>so many</em> "minimal" generators but each one ended up having some glaring issue or heavy reliance on dependencies. </p> -<p>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.</p> +<h1 id="about-">About <code>barf</code></h1> +<p>barf is a minimal and suckless-inspired blog generator. It is a tweaked and slightly patched version of Karl Bartel’s fantastic <a href="https://github.com/karlb/karl.berlin">blog.sh</a>.</p> +<h2 id="why">Why?</h2> +<p>This project was created by me, <a href="https://btxx.org">Bradley Taunt</a>, out of frustration with overly complex and bloated blogging options. I tried <em>so many</em> “minimal” generators but each one ended up having some glaring issue or heavy reliance on dependencies. </p> +<p>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.</p> <footer role="contentinfo"> <hr> <h3 id="menu">Menu Navigation</h3> diff --git a/build/atom.xml b/build/atom.xml index 8b1b84d..145d5a8 100644 --- a/build/atom.xml +++ b/build/atom.xml @@ -2,16 +2,16 @@ <feed xmlns="http://www.w3.org/2005/Atom"> <title>barf</title> <link href="https://barf.btxx.org/atom.xml" rel="self" /> - <updated>2024-06-06T10:08:02Z</updated> + <updated>2024-06-07T10:26:51Z</updated> <author> - <name></name> + <name>Bradley Taunt</name> </author> <id>https://barf.btxx.org,2024-01-19:default-atom-feed/</id> <entry> <title>Quality of Life Improvements</title> - <content type="html"><h1>Quality of Life Improvements</h1> + <content type="html"><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>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> @@ -25,7 +25,11 @@ <ul> <li>You now only need to set your main domain at the top of the core <code>barf</code> file.</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><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></content> <link href="https://barf.btxx.org/qol"/> <id>https://barf.btxx.org/qol</id> @@ -34,10 +38,10 @@ </entry> <entry> <title>Running `barf` on OpenBSD</title> - <content type="html"><h1>Running <code>barf</code> on OpenBSD</h1> + <content type="html"><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>Download Packages</h2> +<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> @@ -49,21 +53,21 @@ </entry> <entry> <title>Markdown Examples in barf</title> - <content type="html"><h1>Markdown Examples in barf</h1> + <content type="html"><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><code>smu</code> Syntax</h1> +<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> -<li>Lists don't end paragraphs by themselves (blank line needed)</li> -<li>Horizontal rules (<code>&lt;hr&gt;</code>) must use <code>- - -</code> as syntax</li> +<li>Lists don&#8217;t end paragraphs by themselves (blank line needed)</li> +<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't increase the code complexity significantly.</p> +<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> @@ -77,55 +81,40 @@ original smu are:</p> <li>Keep HTML comments in output</li> <li>Improved spec compliance for lists</li> <li>Nesting code block in blockquotes works</li> -<li>"Empty" lines in lists behave identically, no matter how much whitespace they contain</li> +<li>&#8220;Empty&#8221; lines in lists behave identically, no matter how much whitespace they contain</li> <li>No backslash escapes in code blocks</li> <li>Use first number as start number for ordered lists</li> -</ul> -</li> +</ul></li> <li>Added a simple test suite to check for compliance and avoid regressions</li> </ul> -<h2>Inline patterns</h2> +<h2 id="inline-patterns">Inline patterns</h2> <p>There are several patterns you can use to highlight your text:</p> <ul> -<li><p>Emphasis</p> - +<li><p>Emphasis <ul> <li>Surround your text with <code>*</code> or <code>_</code> to get <em>emphasised</em> text: -<pre><code>This *is* cool. -This _is_ cool, too. -</code></pre> -</li> +This <em>is</em> cool. +This <em>is</em> cool, too.</li> <li>Surround your text with <code>**</code> or <code>__</code> to get <strong>strong</strong> text: -<pre><code>This **is** cool. -This __is__ cool, too. -</code></pre> -</li> +This <strong>is</strong> cool. +This <strong>is</strong> cool, too.</li> <li>Surround your text with <code>***</code> or <code>___</code> to get <strong><em>strong and emphasised</em></strong> text: -<pre><code>This ***is*** cool. -This ___is___ cool, too. -</code></pre> -</li> -<li>But this example won't work as expected: -<pre><code>***Hello** you* -</code></pre> -<p>This is a wontfix bug because it would make the source too complex. +This <strong><em>is</em></strong> cool. +This <strong><em>is</em></strong> cool, too.</li> +<li>But this example won&#8217;t work as expected: +*<strong>Hello</strong> you* +This is a wontfix bug because it would make the source too complex. Use this instead: -</p> -<pre><code>***Hello*** *you* -</code></pre> -</li> -</ul> -</li> +<strong><em>Hello</em></strong> <em>you</em></li> +</ul></p></li> <li><p>inline Code</p> <p>You can produce inline code by surrounding it with backticks.</p> -<pre><code>Use `rm -rf /` if you're a N00b. -Use ``rm -rf /`` if you're a N00b. -Use ```rm -rf /``` if you're a N00b. -</code></pre> -<p>Double and triple backticks can be used if the code itself contains backticks.</p> -</li> +<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>Titles</h2> +<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 @@ -136,10 +125,10 @@ Topic </code></pre> <p>This is very intuitive and self explaining. The resulting sourcecode looks like this:</p> -<pre><code>&lt;h1&gt;Heading&lt;/h1&gt; -&lt;h2&gt;Topic&lt;/h2&gt; +<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't like underlining:</p> +<p>Use the following prefixes if you don&#8217;t like underlining:</p> <pre><code># h1 ## h2 ### h3 @@ -147,31 +136,31 @@ this:</p> ##### h5 ###### h6 </code></pre> -<h2>Links</h2> -<p>The simplest way to define a link is with simple <code>&lt;&gt;</code>.</p> -<pre><code>&lt;http://s01.de&gt; +<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>&lt;yourname@s01.de&gt; +<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://s01.de/~gottox/index.cgi/proj_smu) +<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>&lt;a href=&quot;http://s01.de/~gottox/index.cgi/proj_smu&quot;&gt;smu - simple mark up&lt;/a&gt;&lt;/p&gt; +<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>Lists</h2> +<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>&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; +<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 @@ -185,50 +174,43 @@ continously counted. If you want a list starting at 2, you could write:</p> 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 +<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>&gt; Hello -&gt; This is a quote with a [link](http://s01.de/~gottox) +<pre><code>&#62; Hello +&#62; This is a quote with a [link](http:&#47;&#47;s01.de&#47;~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> + + 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) +<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> + 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 -{&quot;some&quot;: &quot;code&quot;} +{"some": "code"} ``` </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>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 | | -------- | -------- | @@ -247,41 +229,48 @@ the table body.</p> | :------- | :------: | -------: | | Left | Center | Right | </code></pre> -<h2>Other interesting stuff</h2> +<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> -<pre><code>Hello -- - - -Hello2 -</code></pre> +<p>Hello</p> +<hr/> +<p>Hello2</p> <p>Result: -</p> -<pre><code>&lt;p&gt; + Hello -&lt;hr /&gt; -</code></pre> -<pre><code>Hello2&lt;/p&gt; -</code></pre> -</li> +</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> -<pre><code>!&quot;#$%&amp;'()*+,-./:;&lt;=&gt;?@[]^_`{|}~\ -</code></pre> -</li> +<p>!&#8221;#$%&#38;&#8217;()*+,-.&#47;:;&#60;=&#62;?@[]^_`{|}~\</p></li> <li><p>To force a linebreak simple add two spaces to the end of the line:</p> -<pre><code>No linebreak +<p>No linebreak here. -But here is -one. -</code></pre> -</li> +But here is<br/> +one.</p></li> </ul> -<h2>embed HTML</h2> +<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 +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></content> +tags.</p> +<div class="footnotes"> +<hr/> +<ol> + +<li id="fn1"> +<p>This is the first footnote&#160;<a href="#fnref1" rev="footnote">&#8617;</a></p> +</li> + +<li id="fn2"> +<p>Just like I promised - another footnote example&#160;<a href="#fnref2" rev="footnote">&#8617;</a></p> +</li> + +</ol> +</div></content> <link href="https://barf.btxx.org/markdown-examples"/> <id>https://barf.btxx.org/markdown-examples</id> <updated>2023-01-05T10:00:00Z</updated> @@ -289,10 +278,10 @@ tags.</p></content> </entry> <entry> <title>Running `barf` on MacOS</title> - <content type="html"><h1>Running <code>barf</code> on MacOS</h1> + <content type="html"><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>Download Packages</h2> +<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 @@ -306,17 +295,18 @@ brew install gnu-sed </entry> <entry> <title>Supporting Basic Dark Mode</title> - <content type="html"><h1>Supporting Basic Dark Mode</h1> + <content type="html"><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>&lt;meta name=&quot;color-scheme&quot; content=&quot;dark light&quot;&gt; +<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> +<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></content> +<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></content> <link href="https://barf.btxx.org/dark-mode"/> <id>https://barf.btxx.org/dark-mode</id> <updated>2023-03-07T10:00:00Z</updated> @@ -324,22 +314,22 @@ brew install gnu-sed </entry> <entry> <title>Cleaning Up barf's Structure</title> - <content type="html"><h1>Cleaning Up barf's Structure</h1> + <content type="html"><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'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> +<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 "default" look of <code>barf</code>, I've simplified things further. The total CSS styling now consists of only:</p> +<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'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; +<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></content> <link href="https://barf.btxx.org/cleanup"/> diff --git a/build/cleanup/index.html b/build/cleanup/index.html index 4c24c20..b567bac 100644 --- a/build/cleanup/index.html +++ b/build/cleanup/index.html @@ -7,7 +7,7 @@ <title>Cleaning Up barf's Structure</title> <link href="/atom.xml" type="application/atom+xml" rel="alternate" title="Atom feed for blog posts" /> <link href="/rss.xml" type="application/rss+xml" rel="alternate" title="RSS feed for blog posts" /> - <style>*{box-sizing:border-box;}body{font-family:sans-serif;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{overflow:auto;}</style> + <style>*{box-sizing:border-box;}body{font-family:sans-serif;line-height:1.33;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{border:1px solid;overflow:auto;padding:5px;}.footnotes{font-size:90%;}</style> </head> <nav> @@ -15,22 +15,22 @@ </nav> <main> -<h1>Cleaning Up barf's Structure</h1> +<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> +<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> +<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"> +<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> <footer role="contentinfo"> diff --git a/build/dark-mode/index.html b/build/dark-mode/index.html index 1c2ecd5..02c75f0 100644 --- a/build/dark-mode/index.html +++ b/build/dark-mode/index.html @@ -7,7 +7,7 @@ <title>Supporting Basic Dark Mode</title> <link href="/atom.xml" type="application/atom+xml" rel="alternate" title="Atom feed for blog posts" /> <link href="/rss.xml" type="application/rss+xml" rel="alternate" title="RSS feed for blog posts" /> - <style>*{box-sizing:border-box;}body{font-family:sans-serif;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{overflow:auto;}</style> + <style>*{box-sizing:border-box;}body{font-family:sans-serif;line-height:1.33;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{border:1px solid;overflow:auto;padding:5px;}.footnotes{font-size:90%;}</style> </head> <nav> @@ -15,17 +15,18 @@ </nav> <main> -<h1>Supporting Basic Dark Mode</h1> +<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"> +<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> +<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> +<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> <footer role="contentinfo"> <hr> <h3 id="menu">Menu Navigation</h3> diff --git a/build/index.html b/build/index.html index 488a398..c04b05b 100644 --- a/build/index.html +++ b/build/index.html @@ -7,7 +7,7 @@ <title>barf</title> <link href="/atom.xml" type="application/atom+xml" rel="alternate" title="Atom feed for blog posts" /> <link href="/rss.xml" type="application/rss+xml" rel="alternate" title="RSS feed for blog posts" /> - <style>*{box-sizing:border-box;}body{font-family:sans-serif;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{overflow:auto;}</style> + <style>*{box-sizing:border-box;}body{font-family:sans-serif;line-height:1.33;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{border:1px solid;overflow:auto;padding:5px;}.footnotes{font-size:90%;}</style> </head> <nav> @@ -15,40 +15,35 @@ </nav> <main> -<h1>barf</h1> +<h1 id="barf">barf</h1> <p><strong>barf is an extremely minimal blog generator.</strong></p> -<p>The entire build script is less than 100 lines of shell.</p> -<p>It could almost be called "suckless", but probably isn't. It was created for those focused on writing, not tinkering.</p> -<p>You can learn more by reading the <a href="https://git.btxx.org/barf/about">official README</a> and view the generated <a href="/atom.xml">Atom feed here</a></p> +<p>The entire build script is >170 lines of shell.</p> +<p>It could almost be called “suckless”, but probably isn’t. It was created for those focused on writing, not tinkering.</p> +<p>You can learn more by reading the <a href="https://git.btxx.org/barf/about">official README</a>.</p> <p><strong>barf</strong> = blogs are really fun</p> -<hr /> -<h3>Get setup in 2 minutes</h3> +<hr/> +<h3 id="get-setup-in-2-minutes">Get setup in 2 minutes</h3> <p><strong>Install dependencies:</strong></p> - -<ul> -<li>For Linux: <code>rsync</code></li> -<li>For macOS: <code>brew install coreutils gnu-sed</code></li> -<li>For OpenBSD: <code>doas pkg_add rsync coreutils gsed cmake gcc</code></li> -</ul> -<p><strong>Clone and install the lightweight markdown parser, <code>smu</code></strong></p> - -<ul> -<li><code>git clone https://git.btxx.org/smu</code></li> -<li><code>cd smu ; make ; sudo make install</code></li> -</ul> -<p><strong>Clone <code>barf</code>:</strong> </p> - -<ul> -<li><code>git clone https://git.btxx.org/barf</code></li> -</ul> +<p>For Linux (Alpine example):</p> +<pre><code>sudo apk add rsync lowdown +</code></pre> +<p>For macOS:</p> +<pre><code>brew install rsync lowdown coreutils gnu-sed +</code></pre> +<p>For OpenBSD:</p> +<pre><code>doas pkg_add rsync lowdown coreutils gsed cmake gcc +</code></pre> +<p><strong>Clone barf:</strong> </p> +<pre><code>git clone https://git.btxx.org/barf +</code></pre> <ol> <li>Open project, change the <code>domain</code> variable at the top of the core barf file</li> <li>Run: <code>make build</code></li> <li>Upload the contents of <code>build</code> to your server! </li> <li>Profit?</li> </ol> -<hr /> -<h3>Articles</h3> +<hr/> +<h3 id="articles">Articles</h3> <ul> <li>2024-06-06 · <a href="qol/">Quality of Life Improvements</a></li> <li>2023-10-09 · <a href="cleanup/">Cleaning Up barf's Structure</a></li> diff --git a/build/macos/index.html b/build/macos/index.html index 06a1e4d..40ed9a8 100644 --- a/build/macos/index.html +++ b/build/macos/index.html @@ -7,7 +7,7 @@ <title>Running `barf` on MacOS</title> <link href="/atom.xml" type="application/atom+xml" rel="alternate" title="Atom feed for blog posts" /> <link href="/rss.xml" type="application/rss+xml" rel="alternate" title="RSS feed for blog posts" /> - <style>*{box-sizing:border-box;}body{font-family:sans-serif;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{overflow:auto;}</style> + <style>*{box-sizing:border-box;}body{font-family:sans-serif;line-height:1.33;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{border:1px solid;overflow:auto;padding:5px;}.footnotes{font-size:90%;}</style> </head> <nav> @@ -15,10 +15,10 @@ </nav> <main> -<h1>Running <code>barf</code> on MacOS</h1> +<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>Download Packages</h2> +<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 diff --git a/build/markdown-examples/index.html b/build/markdown-examples/index.html index 1e28801..44f972e 100644 --- a/build/markdown-examples/index.html +++ b/build/markdown-examples/index.html @@ -7,7 +7,7 @@ <title>Markdown Examples in barf</title> <link href="/atom.xml" type="application/atom+xml" rel="alternate" title="Atom feed for blog posts" /> <link href="/rss.xml" type="application/rss+xml" rel="alternate" title="RSS feed for blog posts" /> - <style>*{box-sizing:border-box;}body{font-family:sans-serif;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{overflow:auto;}</style> + <style>*{box-sizing:border-box;}body{font-family:sans-serif;line-height:1.33;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{border:1px solid;overflow:auto;padding:5px;}.footnotes{font-size:90%;}</style> </head> <nav> @@ -15,21 +15,21 @@ </nav> <main> -<h1>Markdown Examples in barf</h1> +<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><code>smu</code> Syntax</h1> +<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> -<li>Lists don't end paragraphs by themselves (blank line needed)</li> -<li>Horizontal rules (<code><hr></code>) must use <code>- - -</code> as syntax</li> +<li>Lists don’t end paragraphs by themselves (blank line needed)</li> +<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>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> @@ -43,55 +43,40 @@ original smu are:</p> <li>Keep HTML comments in output</li> <li>Improved spec compliance for lists</li> <li>Nesting code block in blockquotes works</li> -<li>"Empty" lines in lists behave identically, no matter how much whitespace they contain</li> +<li>“Empty” lines in lists behave identically, no matter how much whitespace they contain</li> <li>No backslash escapes in code blocks</li> <li>Use first number as start number for ordered lists</li> -</ul> -</li> +</ul></li> <li>Added a simple test suite to check for compliance and avoid regressions</li> </ul> -<h2>Inline patterns</h2> +<h2 id="inline-patterns">Inline patterns</h2> <p>There are several patterns you can use to highlight your text:</p> <ul> -<li><p>Emphasis</p> - +<li><p>Emphasis <ul> <li>Surround your text with <code>*</code> or <code>_</code> to get <em>emphasised</em> text: -<pre><code>This *is* cool. -This _is_ cool, too. -</code></pre> -</li> +This <em>is</em> cool. +This <em>is</em> cool, too.</li> <li>Surround your text with <code>**</code> or <code>__</code> to get <strong>strong</strong> text: -<pre><code>This **is** cool. -This __is__ cool, too. -</code></pre> -</li> +This <strong>is</strong> cool. +This <strong>is</strong> cool, too.</li> <li>Surround your text with <code>***</code> or <code>___</code> to get <strong><em>strong and emphasised</em></strong> text: -<pre><code>This ***is*** cool. -This ___is___ cool, too. -</code></pre> -</li> -<li>But this example won't work as expected: -<pre><code>***Hello** you* -</code></pre> -<p>This is a wontfix bug because it would make the source too complex. +This <strong><em>is</em></strong> cool. +This <strong><em>is</em></strong> cool, too.</li> +<li>But this example won’t work as expected: +*<strong>Hello</strong> you* +This is a wontfix bug because it would make the source too complex. Use this instead: -</p> -<pre><code>***Hello*** *you* -</code></pre> -</li> -</ul> -</li> +<strong><em>Hello</em></strong> <em>you</em></li> +</ul></p></li> <li><p>inline Code</p> <p>You can produce inline code by surrounding it with backticks.</p> -<pre><code>Use `rm -rf /` if you're a N00b. -Use ``rm -rf /`` if you're a N00b. -Use ```rm -rf /``` if you're a N00b. -</code></pre> -<p>Double and triple backticks can be used if the code itself contains backticks.</p> -</li> +<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>Titles</h2> +<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 @@ -102,10 +87,10 @@ 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> +<pre><code><h1>Heading</h1> +<h2>Topic</h2> </code></pre> -<p>Use the following prefixes if you don't like underlining:</p> +<p>Use the following prefixes if you don’t like underlining:</p> <pre><code># h1 ## h2 ### h3 @@ -113,31 +98,31 @@ this:</p> ##### h5 ###### h6 </code></pre> -<h2>Links</h2> -<p>The simplest way to define a link is with simple <code><></code>.</p> -<pre><code><http://s01.de> +<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> +<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) +<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> +<pre><code><a href="http://s01.de/~gottox/index.cgi/proj_smu">smu - simple mark up</a></p> </code></pre> -<h2>Lists</h2> +<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> +<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 @@ -151,50 +136,43 @@ continously counted. If you want a list starting at 2, you could write:</p> 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>Code & Blockquote</h2> -<p>Use the <code>> </code> as a line prefix for defining blockquotes. Blockquotes are +<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) +<pre><code>> Hello +> This is a quote with a [link](http://s01.de/~gottox) </code></pre> <p>Result: -</p> -<pre><code><blockquote><p> -Hello -This is a quote with a <a href="http://s01.de/~gottox">link</a></p> -</blockquote> -</code></pre> + + 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) +<pre><code> this.is(code) this.is(code, too) </code></pre> <p>Result: -</p> -<pre><code><pre><code>this.is(code)</code></pre> -<pre><code>this.is(code, too) -</code></pre> -</code></pre> -<p>Please note that you can't use HTML or smu syntax in a code block.</p> + 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"} +{"some": "code"} ``` </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 & paste</li> -</ul> -<h2>Tables</h2> +<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 | | -------- | -------- | @@ -213,41 +191,48 @@ the table body.</p> | :------- | :------: | -------: | | Left | Center | Right | </code></pre> -<h2>Other interesting stuff</h2> +<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> -<pre><code>Hello -- - - -Hello2 -</code></pre> +<p>Hello</p> +<hr/> +<p>Hello2</p> <p>Result: -</p> -<pre><code><p> + Hello -<hr /> -</code></pre> -<pre><code>Hello2</p> -</code></pre> -</li> +</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> -<pre><code>!"#$%&'()*+,-./:;<=>?@[]^_`{|}~\ -</code></pre> -</li> +<p>!”#$%&’()*+,-./:;<=>?@[]^_`{|}~\</p></li> <li><p>To force a linebreak simple add two spaces to the end of the line:</p> -<pre><code>No linebreak +<p>No linebreak here. -But here is -one. -</code></pre> -</li> +But here is<br/> +one.</p></li> </ul> -<h2>embed HTML</h2> +<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 +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> + +<li id="fn1"> +<p>This is the first footnote <a href="#fnref1" rev="footnote">↩</a></p> +</li> + +<li id="fn2"> +<p>Just like I promised - another footnote example <a href="#fnref2" rev="footnote">↩</a></p> +</li> + +</ol> +</div> <footer role="contentinfo"> <hr> <h3 id="menu">Menu Navigation</h3> diff --git a/build/openbsd/index.html b/build/openbsd/index.html index dc58675..999917a 100644 --- a/build/openbsd/index.html +++ b/build/openbsd/index.html @@ -7,7 +7,7 @@ <title>Running `barf` on OpenBSD</title> <link href="/atom.xml" type="application/atom+xml" rel="alternate" title="Atom feed for blog posts" /> <link href="/rss.xml" type="application/rss+xml" rel="alternate" title="RSS feed for blog posts" /> - <style>*{box-sizing:border-box;}body{font-family:sans-serif;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{overflow:auto;}</style> + <style>*{box-sizing:border-box;}body{font-family:sans-serif;line-height:1.33;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{border:1px solid;overflow:auto;padding:5px;}.footnotes{font-size:90%;}</style> </head> <nav> @@ -15,10 +15,10 @@ </nav> <main> -<h1>Running <code>barf</code> on OpenBSD</h1> +<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>Download Packages</h2> +<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> diff --git a/build/qol/index.html b/build/qol/index.html index bdebf62..bf38b42 100644 --- a/build/qol/index.html +++ b/build/qol/index.html @@ -7,7 +7,7 @@ <title>Quality of Life Improvements</title> <link href="/atom.xml" type="application/atom+xml" rel="alternate" title="Atom feed for blog posts" /> <link href="/rss.xml" type="application/rss+xml" rel="alternate" title="RSS feed for blog posts" /> - <style>*{box-sizing:border-box;}body{font-family:sans-serif;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{overflow:auto;}</style> + <style>*{box-sizing:border-box;}body{font-family:sans-serif;line-height:1.33;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{border:1px solid;overflow:auto;padding:5px;}.footnotes{font-size:90%;}</style> </head> <nav> @@ -15,9 +15,9 @@ </nav> <main> -<h1>Quality of Life Improvements</h1> +<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>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> @@ -31,7 +31,11 @@ <ul> <li>You now only need to set your main domain at the top of the core <code>barf</code> file.</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><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> <footer role="contentinfo"> <hr> diff --git a/build/rss.xml b/build/rss.xml index 992412c..ed78ca1 100644 --- a/build/rss.xml +++ b/build/rss.xml @@ -4,15 +4,15 @@ <title>barf</title> <link>https://barf.btxx.org/rss.xml</link> <description>Feed description here</description> - <lastBuildDate>Thu, 06 Jun 2024 14:08:02 +0000</lastBuildDate> - <pubDate>Thu, 06 Jun 2024 14:08:02 +0000</pubDate> + <lastBuildDate>Fri, 07 Jun 2024 14:26:51 +0000</lastBuildDate> + <pubDate>Fri, 07 Jun 2024 14:26:51 +0000</pubDate> <generator>Custom RSS Generator</generator> <ttl>1800</ttl> <item> <title>Quality of Life Improvements</title> - <description><h1>Quality of Life Improvements</h1> + <description><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>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> @@ -26,7 +26,11 @@ <ul> <li>You now only need to set your main domain at the top of the core <code>barf</code> file.</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><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></description> <link>https://barf.btxx.org/qol</link> <guid isPermaLink="false">https://barf.btxx.org/qol</guid> @@ -34,10 +38,10 @@ </item> <item> <title>Running `barf` on OpenBSD</title> - <description><h1>Running <code>barf</code> on OpenBSD</h1> + <description><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>Download Packages</h2> +<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> @@ -48,21 +52,21 @@ </item> <item> <title>Markdown Examples in barf</title> - <description><h1>Markdown Examples in barf</h1> + <description><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><code>smu</code> Syntax</h1> +<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> -<li>Lists don't end paragraphs by themselves (blank line needed)</li> -<li>Horizontal rules (<code>&lt;hr&gt;</code>) must use <code>- - -</code> as syntax</li> +<li>Lists don&#8217;t end paragraphs by themselves (blank line needed)</li> +<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't increase the code complexity significantly.</p> +<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> @@ -76,55 +80,40 @@ original smu are:</p> <li>Keep HTML comments in output</li> <li>Improved spec compliance for lists</li> <li>Nesting code block in blockquotes works</li> -<li>"Empty" lines in lists behave identically, no matter how much whitespace they contain</li> +<li>&#8220;Empty&#8221; lines in lists behave identically, no matter how much whitespace they contain</li> <li>No backslash escapes in code blocks</li> <li>Use first number as start number for ordered lists</li> -</ul> -</li> +</ul></li> <li>Added a simple test suite to check for compliance and avoid regressions</li> </ul> -<h2>Inline patterns</h2> +<h2 id="inline-patterns">Inline patterns</h2> <p>There are several patterns you can use to highlight your text:</p> <ul> -<li><p>Emphasis</p> - +<li><p>Emphasis <ul> <li>Surround your text with <code>*</code> or <code>_</code> to get <em>emphasised</em> text: -<pre><code>This *is* cool. -This _is_ cool, too. -</code></pre> -</li> +This <em>is</em> cool. +This <em>is</em> cool, too.</li> <li>Surround your text with <code>**</code> or <code>__</code> to get <strong>strong</strong> text: -<pre><code>This **is** cool. -This __is__ cool, too. -</code></pre> -</li> +This <strong>is</strong> cool. +This <strong>is</strong> cool, too.</li> <li>Surround your text with <code>***</code> or <code>___</code> to get <strong><em>strong and emphasised</em></strong> text: -<pre><code>This ***is*** cool. -This ___is___ cool, too. -</code></pre> -</li> -<li>But this example won't work as expected: -<pre><code>***Hello** you* -</code></pre> -<p>This is a wontfix bug because it would make the source too complex. +This <strong><em>is</em></strong> cool. +This <strong><em>is</em></strong> cool, too.</li> +<li>But this example won&#8217;t work as expected: +*<strong>Hello</strong> you* +This is a wontfix bug because it would make the source too complex. Use this instead: -</p> -<pre><code>***Hello*** *you* -</code></pre> -</li> -</ul> -</li> +<strong><em>Hello</em></strong> <em>you</em></li> +</ul></p></li> <li><p>inline Code</p> <p>You can produce inline code by surrounding it with backticks.</p> -<pre><code>Use `rm -rf /` if you're a N00b. -Use ``rm -rf /`` if you're a N00b. -Use ```rm -rf /``` if you're a N00b. -</code></pre> -<p>Double and triple backticks can be used if the code itself contains backticks.</p> -</li> +<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>Titles</h2> +<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 @@ -135,10 +124,10 @@ Topic </code></pre> <p>This is very intuitive and self explaining. The resulting sourcecode looks like this:</p> -<pre><code>&lt;h1&gt;Heading&lt;/h1&gt; -&lt;h2&gt;Topic&lt;/h2&gt; +<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't like underlining:</p> +<p>Use the following prefixes if you don&#8217;t like underlining:</p> <pre><code># h1 ## h2 ### h3 @@ -146,31 +135,31 @@ this:</p> ##### h5 ###### h6 </code></pre> -<h2>Links</h2> -<p>The simplest way to define a link is with simple <code>&lt;&gt;</code>.</p> -<pre><code>&lt;http://s01.de&gt; +<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>&lt;yourname@s01.de&gt; +<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://s01.de/~gottox/index.cgi/proj_smu) +<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>&lt;a href=&quot;http://s01.de/~gottox/index.cgi/proj_smu&quot;&gt;smu - simple mark up&lt;/a&gt;&lt;/p&gt; +<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>Lists</h2> +<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>&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; +<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 @@ -184,50 +173,43 @@ continously counted. If you want a list starting at 2, you could write:</p> 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 +<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>&gt; Hello -&gt; This is a quote with a [link](http://s01.de/~gottox) +<pre><code>&#62; Hello +&#62; This is a quote with a [link](http:&#47;&#47;s01.de&#47;~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> + + 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) +<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> + 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 -{&quot;some&quot;: &quot;code&quot;} +{"some": "code"} ``` </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>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 | | -------- | -------- | @@ -246,51 +228,58 @@ the table body.</p> | :------- | :------: | -------: | | Left | Center | Right | </code></pre> -<h2>Other interesting stuff</h2> +<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> -<pre><code>Hello -- - - -Hello2 -</code></pre> +<p>Hello</p> +<hr/> +<p>Hello2</p> <p>Result: -</p> -<pre><code>&lt;p&gt; + Hello -&lt;hr /&gt; -</code></pre> -<pre><code>Hello2&lt;/p&gt; -</code></pre> -</li> +</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> -<pre><code>!&quot;#$%&amp;'()*+,-./:;&lt;=&gt;?@[]^_`{|}~\ -</code></pre> -</li> +<p>!&#8221;#$%&#38;&#8217;()*+,-.&#47;:;&#60;=&#62;?@[]^_`{|}~\</p></li> <li><p>To force a linebreak simple add two spaces to the end of the line:</p> -<pre><code>No linebreak +<p>No linebreak here. -But here is -one. -</code></pre> -</li> +But here is<br/> +one.</p></li> </ul> -<h2>embed HTML</h2> +<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 +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></description> +tags.</p> +<div class="footnotes"> +<hr/> +<ol> + +<li id="fn1"> +<p>This is the first footnote&#160;<a href="#fnref1" rev="footnote">&#8617;</a></p> +</li> + +<li id="fn2"> +<p>Just like I promised - another footnote example&#160;<a href="#fnref2" rev="footnote">&#8617;</a></p> +</li> + +</ol> +</div></description> <link>https://barf.btxx.org/markdown-examples</link> <guid isPermaLink="false">https://barf.btxx.org/markdown-examples</guid> <pubDate>Thu, 05 Jan 2023 00:00:00 +0000</pubDate> </item> <item> <title>Running `barf` on MacOS</title> - <description><h1>Running <code>barf</code> on MacOS</h1> + <description><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>Download Packages</h2> +<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 @@ -303,39 +292,40 @@ brew install gnu-sed </item> <item> <title>Supporting Basic Dark Mode</title> - <description><h1>Supporting Basic Dark Mode</h1> + <description><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>&lt;meta name=&quot;color-scheme&quot; content=&quot;dark light&quot;&gt; +<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> +<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> +<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></description> <link>https://barf.btxx.org/dark-mode</link> <guid isPermaLink="false">https://barf.btxx.org/dark-mode</guid> <pubDate>Tue, 07 Mar 2023 00:00:00 +0000</pubDate> </item> <item> <title>Cleaning Up barf's Structure</title> - <description><h1>Cleaning Up barf's Structure</h1> + <description><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'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> +<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 "default" look of <code>barf</code>, I've simplified things further. The total CSS styling now consists of only:</p> +<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'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; +<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></description> <link>https://barf.btxx.org/cleanup</link> diff --git a/build/websites/index.html b/build/websites/index.html index 29715cd..8a06384 100644 --- a/build/websites/index.html +++ b/build/websites/index.html @@ -7,7 +7,7 @@ <title>Websites Built with `barf`</title> <link href="/atom.xml" type="application/atom+xml" rel="alternate" title="Atom feed for blog posts" /> <link href="/rss.xml" type="application/rss+xml" rel="alternate" title="RSS feed for blog posts" /> - <style>*{box-sizing:border-box;}body{font-family:sans-serif;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{overflow:auto;}</style> + <style>*{box-sizing:border-box;}body{font-family:sans-serif;line-height:1.33;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{border:1px solid;overflow:auto;padding:5px;}.footnotes{font-size:90%;}</style> </head> <nav> @@ -15,7 +15,7 @@ </nav> <main> -<h1>Websites Built with <code>barf</code></h1> +<h1 id="websites-built-with-">Websites Built with <code>barf</code></h1> <p>Send an email to bt [at] btxx [dot] org if you would like me to add your barf-generated website to this list.</p> <ul> <li><a href="https://jsfree.org">jsfree.org</a></li> diff --git a/header.html b/header.html index 7b95bf6..9c9c6c6 100644 --- a/header.html +++ b/header.html @@ -7,7 +7,7 @@ <title>{{TITLE}}</title> <link href="/atom.xml" type="application/atom+xml" rel="alternate" title="Atom feed for blog posts" /> <link href="/rss.xml" type="application/rss+xml" rel="alternate" title="RSS feed for blog posts" /> - <style>*{box-sizing:border-box;}body{font-family:sans-serif;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{overflow:auto;}</style> + <style>*{box-sizing:border-box;}body{font-family:sans-serif;line-height:1.33;margin:0 auto;max-width:650px;padding:1rem;}img{max-width:100%;}pre{border:1px solid;overflow:auto;padding:5px;}.footnotes{font-size:90%;}</style> </head> <nav> @@ -2,11 +2,11 @@ **barf is an extremely minimal blog generator.** -The entire build script is less than 100 lines of shell. +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](https://git.btxx.org/barf/about) and view the generated [Atom feed here](/atom.xml) +You can learn more by reading the [official README](https://git.btxx.org/barf/about). **barf** = blogs are really fun @@ -15,16 +15,22 @@ You can learn more by reading the [official README](https://git.btxx.org/barf/ab ### Get setup in 2 minutes **Install dependencies:** -* For Linux: `rsync` -* For macOS: `brew install coreutils gnu-sed` -* For OpenBSD: `doas pkg_add rsync coreutils gsed cmake gcc` -**Clone and install the lightweight markdown parser, `smu`** -* `git clone https://git.btxx.org/smu` -* `cd smu ; make ; sudo make install` +For Linux (Alpine example): -**Clone `barf`:** -* `git clone https://git.btxx.org/barf` + 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 + +**Clone barf:** + + git clone https://git.btxx.org/barf 1. Open project, change the `domain` variable at the top of the core barf file 2. Run: `make build` diff --git a/posts/markdown-examples.md b/posts/markdown-examples.md index dc3d2dc..1c2d564 100644 --- a/posts/markdown-examples.md +++ b/posts/markdown-examples.md @@ -216,6 +216,11 @@ the table body. | :------- | :------: | -------: | | Left | Center | Right | +Footnotes +--------- + +Here is an example of using Markdown footnotes[^1]. And incase you were looking for more examples, here is another one[^2]. + Other interesting stuff ----------------------- @@ -252,3 +257,6 @@ 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. + +[^1]: This is the first footnote +[^2]: Just like I promised - another footnote example diff --git a/posts/qol.md b/posts/qol.md index f09694e..57da105 100644 --- a/posts/qol.md +++ b/posts/qol.md @@ -17,6 +17,10 @@ I haven't circled back to `barf` in quite a bit of time, so I'm happy to announc * 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! |