Markdown showroom

Here are a few examples in Markdown. While Markdown has significantly fewer features compared to other markup languages like AsciiDoc, it still offers a simple and efficient way to write and format blog posts. It’s especially useful for quickly creating clean, readable content without much overhead. Jekyll uses Kramdown as its Markdown processor. Therefore, you can also use Kramdown syntax.

For more information, you can check out

• The official Markdown syntax guide
• Wikipedia article about Markdown
• Kramdown Syntax
• Kramdown Quick Reference
• Kramdown Cheat Sheet

Source code listings

Python source code:

# Python code
def greet(name):
    print(f"Hello, {name}!")

greet('World')

Ruby code listings using Kramdown syntax:

puts "Hello! What's your name?"
# gets user input and removes the newline
name = gets.chomp
puts "Hi, #{name}!"

# Define the function
def square(number)
  number * number
end

# Use the function
puts "Enter a number to square:"
num = gets.chomp.to_i
result = square(num)

puts "The square of #{num} is #{result}"

Text formatting

• Text with strong significance to me
• Emphasized text
• Combination of both
• You can also format parts of a word:
  • Create, Read, Update, and Delete (CRUD)
  • Counterclockwise
  • strings
• This is strikethrough text
• monospace text

Links

• https://example.com
• Link to example.com
• test@example.com
• send a test message to example.com

Tables

A simple table:

A table with alignment and some markdown features:

Lists

Unordered

• Item 1
• Item 2
  • Item 2.1
  • Item 2.2
  • Item 2.3
• Item 3

Numbered

1. Numbered item 1
2. Numbered item 2
   1. Numbered item 2.1
   2. Numbered item 2.2
   3. Numbered item 2.3
3. Numbered item 3

Checklist

• checked: * [x] (lower case x)
• checked: * [X] (or upper case X)
• checked: - [x]
• unchecked: - [ ]
• unchecked: * [ ]
  • item without checkbox
  • unchecked item on level 2: * [ ]
    • checked item on level 3: * [x]

Images

Quotes

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Glossary

Term 1

Definition for Term 1.

Term 2

Definition for Term 2. Text can have multiple lines. They can also contain lists …

• item 1
• item 2
• item 3

  … and they can also contain quotes.

Another definition for Term 2.