From 8a3e4e5207f59d42bfd6075e3792267266c86e71 Mon Sep 17 00:00:00 2001 From: Bradley Taunt Date: Fri, 7 Jun 2024 10:27:38 -0400 Subject: Homepage changes, README updates, swap to lowdown, cleanup --- build/markdown-examples/index.html | 205 +++++++++++++++++-------------------- 1 file changed, 95 insertions(+), 110 deletions(-) (limited to 'build/markdown-examples/index.html') 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 @@ Markdown Examples in barf - +
-

Markdown Examples in barf

+

Markdown Examples in barf

2023-01-05

-

This following was lifted from https://github.com/karlb/smu

-

smu Syntax

+

This following was lifted from https://github.com/karlb/smu

+

smu Syntax

smu was started as a rewrite of markdown but became something more lightweight and consistent. It differs from CommonMark in the following ways:

-

Patches that increase the CommonMark compatibility are welcome as long as they don't increase the code complexity significantly.

+

Patches that increase the CommonMark compatibility are welcome as long as they don’t increase the code complexity significantly.

This project is a fork of the original smu by Enno Boland (gottox). The main differences to the original smu are:

@@ -43,55 +43,40 @@ original smu are:

  • Keep HTML comments in output
  • Improved spec compliance for lists
  • Nesting code block in blockquotes works
    • -
  • "Empty" lines in lists behave identically, no matter how much whitespace they contain
    • +
  • “Empty” lines in lists behave identically, no matter how much whitespace they contain
  • No backslash escapes in code blocks
  • Use first number as start number for ordered lists
    • - - +
  • Added a simple test suite to check for compliance and avoid regressions
    • -

    Inline patterns

    +

    Inline patterns

    There are several patterns you can use to highlight your text:

  • inline Code

    You can produce inline code by surrounding it with backticks.

    -
    Use `rm -rf /` if you're a N00b.
-Use ``rm -rf /`` if you're a N00b.
-Use ```rm -rf /``` if you're a N00b.
-
    -

    Double and triple backticks can be used if the code itself contains backticks.

    -
    • +

    Use rm -rf / if you’re a N00b. +Use rm -rf / if you’re a N00b. +Use rm -rf / if you’re a N00b.

    +

    Double and triple backticks can be used if the code itself contains backticks.

    -

    Titles

    +

    Titles

    Creating titles in smu is very easy. There are two different syntax styles. The first is underlining with at least three characters:

    Heading
@@ -102,10 +87,10 @@ Topic

    This is very intuitive and self explaining. The resulting sourcecode looks like this:

    -
    <h1>Heading</h1>
-<h2>Topic</h2>
+
    <h1>Heading</h1>
+<h2>Topic</h2>
 
    
-
    Use the following prefixes if you don't like underlining:
    
+
    Use the following prefixes if you don’t like underlining:
    
 
    # h1
 ## h2
 ### h3
@@ -113,31 +98,31 @@ this:
    
 ##### h5
 ###### h6
 
    
-
    Links
    
-
    The simplest way to define a link is with simple <>.
    
-
    <http://s01.de>
+
+
    The simplest way to define a link is with simple <>.
    
+
    <http://s01.de>
 
    
 
    You can do the same for E-Mail addresses:
    
-
    <yourname@s01.de>
+
    <yourname@s01.de>
 
    
 
    If you want to define a label for the url, you have to use a different syntax
    
-
    [smu - simple mark up](http://s01.de/~gottox/index.cgi/proj_smu)
+
    [smu - simple mark up](http://s01.de/~gottox/index.cgi/proj_smu)
 
    
 
    The resulting HTML-Code
    
-
    <a href="http://s01.de/~gottox/index.cgi/proj_smu">smu - simple mark up</a></p>
+
    <a href="http://s01.de/~gottox/index.cgi/proj_smu">smu - simple mark up</a></p>
 
    
-
    Lists
    
+
    Lists
    
 
    Defining lists is very straightforward:
    
 
    * Item 1
 * Item 2
 * Item 3
 
    
 
    Result:
    
-
    <ul>
-<li>Item 1</li>
-<li>Item 2</li>
-<li>Item 3</li>
-</ul>
+
    <ul>
+<li>Item 1</li>
+<li>Item 2</li>
+<li>Item 3</li>
+</ul>
 
    
 
    Defining ordered lists is also very easy:
    
 
    1. Item 1
@@ -151,50 +136,43 @@ continously counted. If you want a list starting at 2, you could write:
    
 2. Item 3
 
    
 
    and get the following HTML which will render with the numbers 2, 3, 4:
    
-
    <ol start="2">
-<li>Item 1</li>
-<li>Item 2</li>
-<li>Item 3</li>
-</ol>
-
    
-
    Code & Blockquote
    
-
    Use the >  as a line prefix for defining blockquotes. Blockquotes are
+
    <ol start="2">
+<li>Item 1</li>
+<li>Item 2</li>
+<li>Item 3</li>
+</ol>
+
    
+
    Code & Blockquote
    
+
    Use the > as a line prefix for defining blockquotes. Blockquotes are
 interpreted as well. This makes it possible to embed links, headings and even
 other quotes into a quote:
    
-
    > Hello
-> This is a quote with a [link](http://s01.de/~gottox)
+
    > Hello
+> This is a quote with a [link](http://s01.de/~gottox)
 
    
 
    Result:
-
    
-
    <blockquote><p>
-Hello
-This is a quote with a <a href="http://s01.de/~gottox">link</a></p>
-</blockquote>
-
    
+    
+    Hello
+    This is a quote with a link
+    
    
 
    You can define a code block with a leading Tab or with 4 leading spaces
    
-
    	this.is(code)
+
        this.is(code)
 
     this.is(code, too)
 
    
 
    Result:
-
    
-
    <pre><code>this.is(code)</code></pre>
-<pre><code>this.is(code, too)
-</code></pre>
-
    
-
    Please note that you can't use HTML or smu syntax in a code block.
    
+    this.is(code)
+    this.is(code, too)
+    
    
+
    Please note that you can’t use HTML or smu syntax in a code block.
    
 
    Another way to write code blocks is to use code fences:
    
 
    ```json
-{"some": "code"}
+{"some": "code"}
 ```
 
    
-
    This has two advantages:
    
-
-
      
-
    • The optional language identifier will be turned into a language- class name
      • 
-
    • You can keep the original indentation which helps when doing copy & paste
      • 
-
    
-
    Tables
    
+
    This has two advantages:
+* The optional language identifier will be turned into a language- class name
+* You can keep the original indentation which helps when doing copy & paste
    
+
    Tables
    
 
    Tables can be generated with the following syntax:
    
 
    | Heading1 | Heading2 |
 | -------- | -------- |
@@ -213,41 +191,48 @@ the table body.
    
 | :------- | :------: | -------: |
 | Left     | Center   | Right    |
 
    
-
    Other interesting stuff
    
+
    Footnotes
    
+
    Here is an example of using Markdown footnotes1. And incase you were looking for more examples, here is another one2.
    
+
    Other interesting stuff
    
 
      
 
    • to insert a horizontal rule simple add - - - into an empty line:
      
-
      Hello
-- - -
-Hello2
-
      
+
      Hello
      
+
      
+
      Hello2
      
 
      Result:
-
      
-
      <p>
+
 Hello
-<hr />
-
      
-
      Hello2</p>
-
      
-
      • 
+
      
+
      Hello2
      
 
    • Any ASCII punctuation character may escaped by precedeing them with a
 backslash to avoid them being interpreted:
      
-
      !"#$%&'()*+,-./:;<=>?@[]^_`{|}~\
-
      
-
      • 
+
      !”#$%&’()*+,-./:;<=>?@[]^_`{|}~\
      
 
    • To force a linebreak simple add two spaces to the end of the line:
      
-
      No linebreak
+
      No linebreak
 here.
-But here is  
-one.
-
      
-
      • 
+But here is
      
+one.
      
 
    
-
    embed HTML
    
+
    embed HTML
    
 
    You can include arbitrary HTML code in your documents. The HTML will be
 passed through to the resulting document without modification. This is a good
-way to work around features that are missing in smu. If you don't want this
+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. 
+
+
    2. 
+
      Just like I promised - another footnote example ↩
      
+
      3. 
+
+
    
+