kilroy/yab-ssg

Fork 0

Files

kilroy b16e085240 Basic Markdown document to do testing with

2025-11-28 19:38:38 -05:00

5.9 KiB

Raw Blame History

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5

Heading 6

Horizontal rule below me

Horizontal rule above me

Heading 1 No Space

Heading 2 No Space

Heading 3 No Space

Heading 4 No Space

Heading 5 No Space

Heading 6 No Space

Heading 1 with two or more equal signs

Heading 2 with two or more dashes

Paragraph 1.

Paragraph 2 with many line breaks that will automatically be turned into one long line.

Paragraph 3; one literal long line.

Paragraph 4 with rendered
line breaks (two spaces
after the end of a
line)

Paragraph 5 with HTML
line breaks in <br> tags
...yeah...

Bold is made with two asterisks (**I'm emboldened**).

Italics is made with one asterisk (*I'm in italics*).

Bold and italics can also be done with underscores.

Underscores will not work in these instances:
Love__is__bold (It should look like "Loveisbold", not "Loveisbold")
A_cat_meow (It should look like "Acatmeow", not "Acatmeow")

Bold and italic text can be made with one emboldening pair of characters and one italicizing pair of characters.

I say Hello world! (three asterisks ***)
I say Hello world! (three underscores ___)
I say Hello world! (one underscore; two asterisks _**)
I say Hello world! (two asterisks; one underscore **_)
I say Hello world! (two underscores; one asterisk __*)
I say Hello world! (one asterisk; two underscores *__)

Again, there cannot be underscores in the middle of a word.

I'm a blockquote

I'm a blockquote...

...with many paragraphs.

I'm a blockquote...

So am I! But within another one.

I'm a blockquote

With a heading

And a

list...

Along with some more formatting! Very cool.

I'm
An
Ordered
List
I am also an ordered list.
But I should still be the same output as the above list.
Yeah.
Same
Thing
Here
BTW
I'm an ordered list.
Here are some indents.
1. Wow
2. Very nice
Third Item
Fourth...
1. Indented item

Some may use parentheses
Like me.

I'm an unordered list
2
3
4

I'm also an unordered list
But with asterisks
Very...
nice...

Again, I'm an unordered list
With plus signs!

And here are some indents.
Second Item
Third Item
- Indented 1
- Indented 2
Fourth Item

To start unordered lists with numbers followed by a period, do this:

1969. What a great year for science!
Beat that, USSR!

Mixing unordered list signs is bad. But, I think it should still be allowed, but with a warning in the parser.

First (+)

Second (-)

Third (*)

Fourth (+)

Now onto adding elements in lists.

To "interrupt" a list with some element, then "continue" the list again, do this:

First
Second. Let's interrupt:

There is an empty (or at least, a newline with some whitespace) line above and below me. I am also indented by four spaces or one tab.
Third. I continue!

Same with blockquotes:

First
Second

Blockquote
Third

Adding codeblocks in lists. Indent by 8 spaces or two tabs, because the first indent is for adding the element, and the second is for making the code block.

Step 1

Step 2

 <html>
   <head>
     <title>hello world</title>
   </head>

Step 3

Images

Blah
Blah blah
Wow that was Tux!

You can nest lists within lists.

First
Second
Third
- Unordered
- Wow.
Fourth

Unordered
Un
Or
1. First
2. Second
Dered

Code!

Enclose in `backticks`:

Type vim to open one of the best editors ever.

To escape backticks, do this:
``Okay we're escaping this: `vim`. Wow that was easy.``
Which looks like:
Okay we're escaping this: vim. Wow that was easy.

Code blocks: Two ways...

Indent by 4 spaces or one tab:
int main() { printf("wow\n"); return 0; }

Or, my personal favorite, use three backticks:

int main()
{
    printf("wow\n");
    return 0;
}

Then to enable highlighting for a language:

```python ...Python code here... ```

print("hello world!")

#include <stdio.h>
int main()
{
    printf("hello world!\n");
    return 0;
}

Links:

[Alias; like the alt attribute in <a> tags](www.actual-link.com)

I like Duck Duck Go

To add a title that shows when you hover your cursor over the link, add a string after the link

[Alias; like the alt attribute in <a> tags](www.actual-link.com "I'm a title")

I like Duck Duck Go

URLs & Emails:

https://www.markdownguide.org fake@example.com

And you can use formatting within the links:

I love supporting the **[EFF](https://eff.org)**.
This is the *[Markdown Guide](https://www.markdownguide.org)*.
See the section on [`code`](#code).

I love supporting the EFF. This is the Markdown Guide. See the section on code.

Reference style links:

First part:

hobbit-hole

Second part (in multiple formats):

[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle
[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle "Hobbit lifestyles"
[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle 'Hobbit lifestyles'
[1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle (Hobbit lifestyles)
[1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> "Hobbit lifestyles"
[1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> 'Hobbit lifestyles'
[1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> (Hobbit lifestyles)

And so:

I live in a hobbit-hole. It's very nice.

You should read Tolkien!

5.9 KiB Raw Blame History