The Complete Markdown Guide
A comprehensive guide to Markdown syntax, featuring all common formatting elements and advanced usage examples.
The Complete Markdown Guide
Introduction
Markdown is a lightweight markup language designed to make it easy to write and read formatted text. Created by John Gruber in 2004, it has become one of the most popular formats for writing documentation, README files, and blog posts.
Basic Syntax
Headers
Headers in Markdown are created using the #
symbol. The number of #
symbols indicates the level of the heading:
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Heading 6
Emphasis
You can make text italic by surrounding it with single asterisks or underscores:
- italic text or italic text
Make text bold using double asterisks or underscores:
- bold text or bold text
Combine them for bold and italic text.
Lists
Unordered Lists
- First item
- Second item
- Nested item
- Another nested item
- Third item
Ordered Lists
- First item
- Second item
- Nested item
- Another nested item
- Third item
Links and Images
Code
Inline code: const greeting = "Hello, World!"
Code blocks:
function calculateSum(a, b) { return a + b; } // Example usage const result = calculateSum(5, 3); console.log(result); // Output: 8
Blockquotes
This is a blockquote It can span multiple lines
And can contain formatted text
Tables
Header 1 | Header 2 | Header 3 |
---|---|---|
Cell 1 | Cell 2 | Cell 3 |
Cell 4 | Cell 5 | Cell 6 |
Extended Syntax
Task Lists
- Write the introduction
- Add basic syntax examples
- Include advanced examples
- Review and publish
Footnotes
Here's a sentence with a footnote1.
Definition Lists
Term : Definition for the term : Another definition for the term
Term 2 : Definition for term 2
Best Practices
- Keep lines concise and readable
- Use blank lines to separate elements
- Indent nested elements consistently
- Use reference links for repeated URLs
- Include a table of contents for long documents
Conclusion
Markdown's simplicity and flexibility make it an excellent choice for creating well-formatted documents. With WebInk, you can easily convert any web content into clean, organized Markdown format.
This guide was created using WebInk's Markdown conversion features.
Footnotes
-
This is the footnote content. ↩