From 77deda68beb468f2ba67c1eb2899f834de5ab317 Mon Sep 17 00:00:00 2001 From: bt Date: Sat, 8 Jun 2024 11:56:18 -0400 Subject: Use openrsync for OpenBSD systems, alter README --- build/markdown-examples/index.html | 81 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 78 insertions(+), 3 deletions(-) (limited to 'build/markdown-examples') diff --git a/build/markdown-examples/index.html b/build/markdown-examples/index.html index 44f972e..25683ea 100644 --- a/build/markdown-examples/index.html +++ b/build/markdown-examples/index.html @@ -16,12 +16,17 @@

Markdown Examples in barf

+

2023-01-05

+

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

+

smu Syntax

+

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

+ +

Titles

+

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

+ 
Heading
 =======
 
 Topic
 -----
+

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

+ 
<h1>Heading</h1>
 <h2>Topic</h2>
+

Use the following prefixes if you don’t like underlining:

+ 
# h1
 ## h2
 ### h3
@@ -98,127 +121,179 @@ this:

 ##### h5
 ###### h6
+ +

The simplest way to define a link is with simple <>.

+ 
<http://s01.de>
+

You can do the same for E-Mail addresses:

+ 
<yourname@s01.de>
+

If you want to define a label for the url, you have to use a different syntax

+ 
[smu - simple mark up](http://s01.de/~gottox/index.cgi/proj_smu)
+

The resulting HTML-Code

+ 
<a href="http://s01.de/~gottox/index.cgi/proj_smu">smu - simple mark up</a></p>
+

Lists

+

Defining lists is very straightforward:

+ 
* Item 1
 * Item 2
 * Item 3
+

Result:

+ 
<ul>
 <li>Item 1</li>
 <li>Item 2</li>
 <li>Item 3</li>
 </ul>
+

Defining ordered lists is also very easy:

+ 
1. Item 1
 2. Item 2
 3. Item 3
+

Only the first number in a list is meaningful. All following list items are continously counted. If you want a list starting at 2, you could write:

+ 
2. Item 1
 2. Item 2
 2. Item 3
+

and get the following HTML which will render with the numbers 2, 3, 4:

+ 
<ol start="2">
 <li>Item 1</li>
 <li>Item 2</li>
 <li>Item 3</li>
 </ol>
+

Code & Blockquote

+

Use the > as a line prefix for defining blockquotes. Blockquotes are interpreted as well. This makes it possible to embed links, headings and even other quotes into a quote:

+ 
> Hello
 > This is a quote with a [link](http://s01.de/~gottox)
+

Result: Hello This is a quote with a link

+

You can define a code block with a leading Tab or with 4 leading spaces

+ 
    this.is(code)
 
     this.is(code, too)
+

Result: this.is(code) this.is(code, too)

+

Please note that you can’t use HTML or smu syntax in a code block.

+

Another way to write code blocks is to use code fences:

+ 
```json
 {"some": "code"}
 ```
+

This has two advantages: * The optional language identifier will be turned into a language- class name * You can keep the original indentation which helps when doing copy & paste

+

Tables

+

Tables can be generated with the following syntax:

+ 
| Heading1 | Heading2 |
 | -------- | -------- |
 | Cell 1   | Cell2    |
+

Aligning the columns make the input nicer to read, but is not necessary to get correct table output. You could just write

+ 
| Heading1 | Heading2 |
 | --- | --- |
 | Cell 1 | Cell2 |
+

To align the content of table cells, use |:--| for left, |--:| for right and |:--:| for centered alignment in the row which separates the header from the table body.

+ 
| Heading1 | Heading2 | Heading3 |
 | :------- | :------: | -------: |
 | Left     | Center   | Right    |
+

Footnotes

+

Here is an example of using Markdown footnotes1. And incase you were looking for more examples, here is another one2.

+

Other interesting stuff

+ +

embed HTML

+

You can include arbitrary HTML code in your documents. The HTML will be passed through to the resulting document without modification. This is a good way to work around features that are missing in smu. If you don’t want this behaviour, use the -n flag when executing smu to stricly escape the HTML tags.

+
    -- cgit v1.2.3-54-g00ecf