Example Post
Published on: 02 Aug 2025
This is an example post that demonstrates various Markdown elements and syntax.
Callouts / Custom Containers
::: callout-info Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque sed lacinia orci. Proin cursus elit nisl, ac condimentum risus dignissim id. Suspendisse accumsan accumsan mi a volutpat. Phasellus gravida metus ut lacinia eleifend. Maecenas hendrerit vel lorem non fringilla. Mauris aliquet nisl a faucibus eleifend. Integer consequat purus ac convallis facilisis. Donec ornare diam sed sapien sagittis, quis lacinia risus ullamcorper. Phasellus magna turpis, gravida at dapibus sed, faucibus vitae nisi. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Aliquam vel interdum libero. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. :::
::: callout-success Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque sed lacinia orci. Proin cursus elit nisl, ac condimentum risus dignissim id. Suspendisse accumsan accumsan mi a volutpat. Phasellus gravida metus ut lacinia eleifend. Maecenas hendrerit vel lorem non fringilla. Mauris aliquet nisl a faucibus eleifend. Integer consequat purus ac convallis facilisis. Donec ornare diam sed sapien sagittis, quis lacinia risus ullamcorper. Phasellus magna turpis, gravida at dapibus sed, faucibus vitae nisi. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Aliquam vel interdum libero. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. :::
::: callout-warning Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque sed lacinia orci. Proin cursus elit nisl, ac condimentum risus dignissim id. Suspendisse accumsan accumsan mi a volutpat. Phasellus gravida metus ut lacinia eleifend. Maecenas hendrerit vel lorem non fringilla. Mauris aliquet nisl a faucibus eleifend. Integer consequat purus ac convallis facilisis. Donec ornare diam sed sapien sagittis, quis lacinia risus ullamcorper. Phasellus magna turpis, gravida at dapibus sed, faucibus vitae nisi. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Aliquam vel interdum libero. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. :::
Basic Text Formatting
Headings
h1 Heading
h2 Heading
h3 Heading
h4 Heading
h5 Heading
h6 Heading
Paragraphs
I've decided to skip last year's Advent of Code edition. Mostly because I didn't have time, but I also knew that I probably wouldn't finish it. I've never finished any edition. I'm not very good at code katas, and I usually try to brute force them. With AoC, that works for the first ten days, but then the challenges start to get more and more complicated, and adding the @jit decorator to speed up my ugly Python code can only get me so far.
But one thing that helped me a lot with the previous editions was to use IPython. Solving those problems incrementally is what actually makes it fun. You start by hard-coding the simple example that comes with each task. Then you try to find a solution for this small-scale problem. You try different things, you wrangle with the input data, and after each step, you see the output, so you know if you are getting closer to solving it or not. Once you manage to solve the simple case, you load the actual input data, and you run it just to find out that there were a few corner cases that you missed. It wouldn't be fun if I had to use a compiled language and write a full program to see the first results.
This year, instead of doing the "Advent of Code," I've decided to do an "Advent of IPython" on Twitter - for 25 days, I've shared tips that can help you when you're solving problems like AoC using IPython. Here is a recap of what you can do.
Emphasis
This is bold text
This is italic text
Strikethrough
Blockquotes
Blockquotes can also be nested...
...by using additional greater-than signs right next to each other...
...or with spaces between arrows.
Another example:
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque sed lacinia orci. Proin cursus elit nisl, ac condimentum risus dignissim id. Suspendisse accumsan accumsan mi a volutpat. Phasellus gravida metus ut lacinia eleifend. Maecenas hendrerit vel lorem non fringilla. Mauris aliquet nisl a faucibus eleifend. Integer consequat purus ac convallis facilisis. Donec ornare diam sed sapien sagittis, quis lacinia risus ullamcorper. Phasellus magna turpis, gravida at dapibus sed, faucibus vitae nisi. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Aliquam vel interdum libero. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.
-- Benjamin Franklin
Lists
Unordered List
- Create a list by starting a line with
+
,-
, or*
- Sub-lists are made by indenting 2 spaces:
- Marker character change forces new list start:
- Ac tristique libero volutpat at
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Marker character change forces new list start:
- Very easy!
Ordered List
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
Another ordered list:
- You can use sequential numbers...
- ...or keep all the numbers as
1.
Start numbering with an offset:
- foo
- bar
Code
Inline code
Indented code
// Some comments line 1 of code line 2 of code line 3 of code
Fenced Code Blocks
Sample text here...
Syntax Highlighting
Python:
from typing import Optional
from fastapi import FastAPI
from pydantic import BaseModel
class Item(BaseModel):
"""Creates an item."""
name: str
description: Optional[str] = None
price: float
tax: Optional[float] = None
app = FastAPI()
@app.post("/items/")
async def create_item(item: Item):
return item
Shell/Bash:
ipython -i my_commands.py
x="Hello World!"
echo $x
cat ./thisisafile.py
JavaScript:
var foo = function (bar) {
return bar++;
};
console.log(foo(5));
Tables
Option | Description |
---|---|
data | path to data files to supply the data that will be passed into templates. |
engine | engine to be used for processing templates. Handlebars is the default. |
ext | extension to be used for dest files. |
Right aligned columns
Option | Description |
---|---|
data | path to data files to supply the data that will be passed into templates. |
engine | engine to be used for processing templates. Handlebars is the default. |
ext | extension to be used for dest files. |
Links and Images
Links
Autoconverted link https://github.com/nodeca/pica (enable linkify to see)
Images
Like links, Images also have a footnote style syntax
With a reference later in the document defining the URL location:
Advanced Markdown & Plugins
The killer feature of markdown-it
is very effective support of syntax plugins.
Emojies
Classic markup: :wink: :crush: :cry: :tear: :laughing: :yum:
Shortcuts (emoticons): :-) :-( 8-) ;)
see how to change output with twemoji.
Subscript / Superscript
- 19^th^
- H~2~O
<ins>
++Inserted text++
<mark>
==Marked text==
Footnotes
Footnote 1 link[^first].
Footnote 2 link[^second].
Inline footnote^[Text of inline footnote] definition.
Duplicated footnote reference[^second].
[^first]: Footnote can have markup
and multiple paragraphs.
[^second]: Footnote text.
Definition lists
Term 1
: Definition 1 with lazy continuation.
Term 2 with inline markup
: Definition 2
{ some code, part of Definition 2 }
Third paragraph of definition 2.
Compact style:
Term 1 ~ Definition 1
Term 2 ~ Definition 2a ~ Definition 2b
Abbreviations
This is HTML abbreviation example.
It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on.
*[HTML]: Hyper Text Markup Language
Custom containers
::: warning here be dragons :::
Typographic replacements
Enable typographer option to see result.
(c) (C) (r) (R) (tm) (TM) (p) (P) +-
test.. test... test..... test?..... test!....
!!!!!! ???? ,, -- ---
"Smartypants, double quotes" and 'single quotes'