Headings
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Heading 6
Paragraphs and Text Styles
This is a standard paragraph. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Here is some bold text, some italic text, and some bold and italic text. You can also use _ for italics like this and __ for bold like this.
For inline code, you can use backticks: const example = 'hello world';.
Sometimes you want to strike through text, like this.
Blockquotes
“The only way to do great work is to love what you do.”
– Steve Jobs
Blockquotes can also be nested:
This is the first level of quoting.
This is nested blockquote.
Back to the first level.
Lists
Unordered List
- Item 1
- Item 2
- Nested Item 2.1
- Nested Item 2.2
- Item 3
Ordered List
- First item
- Second item
- Third item
- Sub-item A
- Sub-item B
Task List (GitHub Flavored Markdown)
- Complete task 1
- Complete task 2
- Incomplete task 3
Code Blocks
Syntax highlighting is handled by Rouge. Here are a few examples.
JavaScript
// A simple function to add two numbers
function add(a, b) {
return a + b;
}
console.log(add(5, 10)); // Outputs: 15
Python
# A simple list comprehension
squares = [x**2 for x in range(10)]
print(squares)
Shell/Bash
# List files in the current directory
ls -la
# Echo a message
echo "Hello from the shell!"
Ruby (Jekyll’s language)
# A simple Ruby class
class Greeter
def initialize(name)
@name = name.capitalize
end
def salute
puts "Hello #{@name}!"
end
end
g = Greeter.new("world")
g.salute
Horizontal Rule
You’ve seen them a few times already. They are created with three or more hyphens, asterisks, or underscores.
Links and Images
Links
Here is a link to the Jekyll website. You can also have a link with a title: Pico.css.
Images
To display an image from your project files, you first need to create a folder for them, like assets/images/. Place your image file in that directory. Then, you can reference it in your markdown like this:
Tables
Tables are great for structured data.
| Header 1 | Header 2 | Header 3 |
|---|---|---|
| Left-aligned | Centered | Right-aligned |
| Cell content | this is | code |
| Cell content | centered | and this |
Footnotes
Here is a sentence with a footnote.1 And here is another one.2
That’s a wrap! This should cover most of the elements you’ll need to style.
]]>