This comprehensive guide covers all the markdown features you need to know as a developer. From basic formatting to advanced tables and code blocks.
Text Formatting
Markdown supports various text formatting options:
- Bold text for emphasis
- Italic text for subtle emphasis
Strikethroughfor deleted content- Bold and italic combined
inline codefor code snippets- Highlighted text for important content
- Inserted text for additions
- Small text for fine print
Headings
You can create headings from H1 to H6 using the # symbol. Each level provides a different hierarchy for your content structure.
This is H3
This is H4
This is H5
This is H6
Lists
Unordered Lists
- First item
- Second item
- Nested item 1
- Nested item 2
- Third item
Ordered Lists
- First step
- Second step
- Third step
- Sub-step A
- Sub-step B
Task Lists
- Completed task
- Another completed task
- Pending task
- Future task
Definition Lists
- HTML
- HyperText Markup Language - the standard markup language for web pages
- CSS
- Cascading Style Sheets - used for styling HTML elements
- JavaScript
- A programming language that enables interactive web pages
Code Blocks
Inline code like const x = 10 is great for short snippets.
For longer code, use fenced code blocks:
function greet(name) {
console.log(`Hello, ${name}!`);
return {
message: 'Welcome',
timestamp: Date.now()
};
}
def calculate_sum(numbers):
return sum(numbers)
result = calculate_sum([1, 2, 3, 4, 5])
print(f\"Sum: {result}\")
npm install react
npm run dev
Tables
Tables are great for comparing data:
| Feature | React | Vue | Angular |
|---|---|---|---|
| Learning Curve | Medium | Easy | Hard |
| Performance | High | High | Medium |
| Community | Large | Growing | Large |
| TypeScript | Optional | Optional | Built-in |
Blockquotes
This is a blockquote. It's perfect for highlighting important information or quoting sources.
You can have multiple paragraphs in a blockquote.
Links and Images
Visit ZetaBox for more information about our services.
Horizontal Rules
Use horizontal rules to separate sections:
Keyboard Shortcuts
Common keyboard shortcuts:
- Press Ctrl + C to copy
- Press Ctrl + V to paste
- Press Ctrl + S to save
- Press Alt + Tab to switch windows
Collapsible Sections
Click to expand - Advanced Configuration
This content is hidden by default. You can put detailed information here that users can expand when needed.
- Configuration option 1
- Configuration option 2
- Configuration option 3
Click to expand - Troubleshooting Guide
Common issues and their solutions:
-
Issue: Module not found Solution: Run
npm install -
Issue: Port already in use Solution: Kill the process or use a different port
Technical Elements
Variables and Sample Output
The variable x represents the input value, and the function returns Success: Operation completed.
Abbreviations
The <abbr title="World Wide Web Consortium">W3C maintains web standards. We use <abbr title="Application Programming Interface">API calls to fetch data.
Citations and Quotes
As stated in The Pragmatic Programmer: Don't Repeat Yourself
is a fundamental principle.
Scientific Notation
- Einstein's equation: E = mc2
- Water molecule: H2O
- Carbon dioxide: CO2
- Exponential: 106 = 1,000,000
Contact Information
ZetaBox Software EngineeringSfax, Tunisia
Email: contact@zeta-box.com
Conclusion
Markdown is a powerful yet simple way to format text. It's widely used in:
- Documentation
- README files
- Blog posts
- Technical writing
- Chat applications
Mastering markdown will make you more productive as a developer!
