Complete Markdown Style Guide
A comprehensive guide showcasing all markdown formatting options and styles available in this blog
Introduction
This post demonstrates all the markdown formatting features available in this blog. From headings to code blocks, we’ve got you covered!
Typography
Headings
We support all heading levels from H1 to H6. Each heading has appropriate sizing and spacing for optimal readability.
Text Formatting
You can use italic text for emphasis, bold text for strong emphasis, and even bold italic for maximum impact. We also support strikethrough text.
Lists
Unordered Lists
Here’s what you can do with lists:
- Create simple bullet points
-
Nest items within items
- Like this nested item
- And another one
- Add multiple levels of depth
- Keep your content organized
Ordered Lists
Follow these steps:
- First, write your content in markdown
-
Add it to the
priv/postsdirectory - Restart the server to compile
- View your beautifully formatted post!
Code Examples
Inline Code
Use inline code for short snippets like mix phx.server or variable names like @post.title.
Code Blocks
Here’s an Elixir example:
defmodule Blog.Post do
@enforce_keys [:id, :title, :body]
defstruct [:id, :title, :body, :tags]
def publish(post) do
post
|> validate()
|> save_to_database()
|> notify_subscribers()
end
end
And a JavaScript example:
function greet(name) {
return `Hello, ${name}! Welcome to Alkahest.`;
}
const message = greet("Developer");
console.log(message);
Blockquotes
“The best way to predict the future is to invent it.”
— Alan Kay
Blockquotes are perfect for highlighting important information or notable quotes.
Links
Check out these resources:
Images
Images are automatically sized and styled with rounded corners and shadows. Perfect for screenshots and diagrams!
Horizontal Rules
Use horizontal rules to separate sections:
Tables
| Feature | Supported | Notes |
|---|---|---|
| Markdown | ✅ Yes | Full support |
| Syntax Highlighting | ✅ Yes | Via Makeup |
| Live Reload | ✅ Yes | Phoenix LiveReload |
| Dark Mode | ✅ Yes | Theme toggle |
Advanced Features
Nested Lists with Code
Here’s a complex example:
-
Setup your environment
- Install Elixir and Erlang
-
Run
mix deps.get
-
Create your first post
touch priv/posts/2026/01-26-my-post.md -
Start the server
-
Development:
mix phx.server -
Production:
MIX_ENV=prod mix phx.server
-
Development:
Mixed Content
You can combine italic, bold, code, and links in a single paragraph for maximum expressiveness.
Conclusion
This markdown style guide showcases the beautiful typography and formatting available in this blog. Every element is carefully styled for readability and visual appeal.
Happy writing! ✨