aboutsummaryrefslogtreecommitdiff
path: root/build/markdown-examples
diff options
context:
space:
mode:
authorBradley Taunt <bt@btxx.org>2024-07-06 07:52:09 -0400
committerBradley Taunt <bt@btxx.org>2024-07-06 07:52:09 -0400
commit2b545623c8d2751aa76ad5de0ebefcadd9b13904 (patch)
treead77fcd7700efc46fbce75e82f609264b627dcb7 /build/markdown-examples
parent80dcfd3c693f756c89f882a3f508f77ad6911c2b (diff)
Remove build and include gitignore
Diffstat (limited to 'build/markdown-examples')
-rw-r--r--build/markdown-examples/index.html250
1 files changed, 0 insertions, 250 deletions
diff --git a/build/markdown-examples/index.html b/build/markdown-examples/index.html
deleted file mode 100644
index b50fe55..0000000
--- a/build/markdown-examples/index.html
+++ /dev/null
@@ -1,250 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width, initial-scale=1">
- <link rel="icon" href="data:,">
- <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;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>
- <a href="#menu">Menu &darr;</a>
-</nav>
-
-<main>
-<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>
-<footer role="contentinfo">
- <hr>
- <h3 id="menu">Menu Navigation</h3>
- <ul>
- <li><a href="/">Home</a></li>
- <li><a href="/about">About</a></li>
- <li><a href="/websites">Websites</a></li>
- <li><a href="https://git.btxx.org/barf">Source Code</a></li>
- </ul>
- <small>
- Feeds: <a href="/atom.xml">Atom</a> | <a href="/rss.xml">RSS</a> <br>
- Built with <a href="https://barf.btxx.org">barf</a>. <br>
- The <a href="https://git.sr.ht/~bt/barf">code for this site</a> is MIT.
- </small>
-</footer> \ No newline at end of file