1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
|
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0">
<channel>
<title>barf</title>
<link>https://barf.btxx.org/rss.xml</link>
<description>Feed description here</description>
<lastBuildDate>Wed, 03 Jul 2024 16:03:07 +0000</lastBuildDate>
<pubDate>Wed, 03 Jul 2024 16:03:07 +0000</pubDate>
<generator>Custom RSS Generator</generator>
<ttl>1800</ttl>
<item>
<title>Quality of Life Improvements</title>
<description><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></description>
<link>https://barf.btxx.org/qol</link>
<guid isPermaLink="false">https://barf.btxx.org/qol</guid>
<pubDate>Thu, 06 Jun 2024 00:00:00 +0000</pubDate>
</item>
<item>
<title>Running `barf` on OpenBSD</title>
<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&#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></description>
<link>https://barf.btxx.org/openbsd</link>
<guid isPermaLink="false">https://barf.btxx.org/openbsd</guid>
<pubDate>Sat, 12 Aug 2023 00:00:00 +0000</pubDate>
</item>
<item>
<title>Markdown Examples in barf</title>
<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:&#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&#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&#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>
<li>Ignore single spaces around code spans</li>
<li>Keep HTML comments in output</li>
<li>Improved spec compliance for lists</li>
<li>Nesting code block in blockquotes works</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>
<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
<ul>
<li>Surround your text with <code>*</code> or <code>_</code> to get <em>emphasised</em> text:
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:
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:
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:
<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>
<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
#### h4
##### 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>
<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>
<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 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></description>
<link>https://barf.btxx.org/macos</link>
<guid isPermaLink="false">https://barf.btxx.org/macos</guid>
<pubDate>Wed, 18 Jan 2023 00:00:00 +0000</pubDate>
</item>
<item>
<title>Supporting Basic Dark Mode</title>
<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>&#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></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 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></description>
<link>https://barf.btxx.org/cleanup</link>
<guid isPermaLink="false">https://barf.btxx.org/cleanup</guid>
<pubDate>Mon, 09 Oct 2023 00:00:00 +0000</pubDate>
</item>
</channel>
</rss>
|