Paragraphs are separated by a blank line.
2nd paragraph. Italic, bold, and monospace
. Itemized lists
look like:
Note that — not considering the asterisk — the actual text content starts at 4-columns in.
Block quotes are written like so.
They can span multiple paragraphs, if you like.
Use 3 dashes for an em-dash. Use 2 dashes for ranges (ex., “it’s all in chapters 12–14”). Three dots … will be converted to an ellipsis. Unicode is supported. ☺
Here’s a numbered list:
Note again how the actual text starts at 4 columns in (4 characters from the left side). Here’s a code sample:
# Let me re-iterate ...
for i in 1 .. 10 { do-something(i) }
As you probably guessed, indented 4 spaces. By the way, instead of indenting the block, you can use delimited blocks, if you like:
define foobar() {
print "Welcome to flavor country!";
}
(which makes copying & pasting easier). You can optionally mark the delimited block for Pandoc to syntax highlight it:
import time
# Quick, count to ten!
for i in range(10):
# (but not *too* quick)
time.sleep(0.5)
print i
Now a nested list:
First, get these ingredients:
Boil some water.
Dump everything in the pot and follow this algorithm:
find wooden spoon
uncover pot
stir
cover pot
balance wooden spoon precariously on pot handle
wait 10 minutes
goto first step (or shut off burner when done)
Do not bump wooden spoon or it will fall.
Notice again how text always lines up on 4-space indents (including that last line which continues item 3 above).
Here’s a link to a website, to a local doc, and to a section heading in the current doc. Here’s a footnote 1.
Tables can look like this:
size material color —- ———— ———— 9 leather brown 10 hemp canvas natural 11 glass transparent
Table: Shoes, their sizes, and what they’re made of
(The above is the caption for the table.) Pandoc also supports multi-line tables:
keyword text ——– ———————– red Sunsets, apples, and other red or reddish things.
green Leaves, grass, frogs and other things it’s not easy being. ——– ———————–
A horizontal rule follows.
Here’s a definition list:
Again, text is indented 4 spaces. (Put a blank line between each term/definition pair to spread things out more.)
Here’s a “line block”:
Line one |
Line too |
Line tree |
and images can be specified like so:
Inline math equations go in like so: $\omega = d\phi / dt$. Display math should get its own line and be put in in double-dollarsigns:
\[I = \int \rho R^{2} dV\]And note that you can backslash-escape any punctuation characters which you wish to be displayed literally, ex.: `foo`, *bar*, etc.
[Markdown | Links | Codecademy](https://www.codecademy.com/resources/docs/markdown/links) |
Links in Markdown are clickable references that connect text to web addresses, files, or other sections within documents. They allow users to navigate between different content by creating hyperlinks using a simple, readable syntax that combines square brackets for link text and parentheses for URLs.
[
Career path
Front-End Engineer
](https://www.codecademy.com/learn/paths/front-end-engineer-career-path)
Front-end engineers work closely with designers to make websites beautiful, functional, and fast.
- Checker Dense
- Includes 34 CoursesIncludes 34 Courses
Checker Dense
With Professional CertificationWith Professional Certification
Checker Dense
Beginner Friendly.Beginner Friendly
115 hours115 hours
[
Free course
Learn HTML
](https://www.codecademy.com/learn/learn-html)
Start at the beginning by learning HTML basics — an important foundation for building and editing web pages.
- Checker Dense
Beginner Friendly.Beginner Friendly
7 hours7 hours
Syntax
The basic syntax for creating links in Markdown uses the following format:
[link text](URL) [link text](URL "title")
Parameters:
link text
: The visible, clickable text that appears in the documentURL
: The web address, file path, or anchor reference where the link pointstitle
(optional): Additional text that appears as a tooltip when hovering over the linkReturn value:
Links render as HTML
<a>
elements with the specified text and destination, creating clickable hyperlinks in the final document.Example 1: Basic Markdown Link Example
Creating a hyperlink to an external website demonstrates the fundamental link syntax in Markdown:
// Create a basic link to a website
Check out the [Codecademy documentation](https://www.codecademy.com/resources/docs) for more resources.
Copy to clipboard
The output of this is:
Check out the Codecademy documentation for more resources.
The link text “Codecademy documentation” becomes clickable and directs users to the specified URL. This example shows the most common use case for Markdown links - connecting to external web resources.
Example 2: Link with Title Example
Adding descriptive titles to links improves accessibility and provides additional context for users:
// Create a link with a descriptive title for better accessibility
Visit our [Python tutorial](https://www.codecademy.com/learn/learn-python-3 ‘Learn Python programming fundamentals’) to start coding today.
// Multiple links with titles in a navigation context
Explore our courses:
- [Web Development](https://www.codecademy.com/catalog/subject/web-development ‘Build modern websites and web applications’)
- [Data Science](https://www.codecademy.com/catalog/subject/data-science ‘Analyze data and create insights’)
- [Machine Learning](https://www.codecademy.com/catalog/subject/machine-learning ‘Build intelligent systems and algorithms’)
Copy to clipboard
The output for this is:
Visit our Python tutorial to start coding today.
Explore our courses:
The title attribute appears as a tooltip when users hover over the link, providing additional context especially useful for screen readers and accessibility tools.
Best Practices to Create Markdown Links
1. Writing Effective Link Text
Always use descriptive, meaningful text that clearly indicates the link destination. Avoid generic phrases that provide no context about where the link leads.
Good examples:
Read the [Python style guide](https://pep8.org) for coding standards.
Download the [latest software release](https://github.com/project/releases/latest).
Copy to clipboard
Avoid:
Click [here](https://pep8.org) for more information.
[Read more](https://github.com/project/releases/latest) about this topic.
Copy to clipboard
2. URL Encoding and Special Characters
When URLs contain parentheses or special characters, encode them properly to prevent parsing issues. Replace opening parentheses with
%28
and closing parentheses with%29
.// Correct way to handle URLs with parentheses
Learn about [Markdown syntax](https://en.wikipedia.org/wiki/Markdown_%28markup_language%29).
// For URLs with spaces, use angle brackets
https://example.com/path with spaces/
Copy to clipboard
3. Reference-Style Links for Organization
Reference-style links improve document maintainability by separating link definitions from their usage. This approach works best when the same URL appears multiple times or when dealing with very long URLs.
// Reference-style links keep the text readable
Check out our [beginner course][python-course] and [advanced topics][python-advanced].
// Link definitions can be placed anywhere in the document
[python-course]: https://www.codecademy.com/learn/learn-python-3 “Learn Python Basics”
[python-advanced]: https://www.codecademy.com/learn/learn-intermediate-python-3 “Advanced Python Concepts”
Copy to clipboard
4. Internal Linking and Anchors
Create internal links to navigate within the same document using the
#
symbol followed by the section heading. Convert headings to lowercase and replace spaces with hyphens.// Link to sections within the same document
See the [Syntax](#syntax) section above for basic formatting rules.
Jump to [Frequently Asked Questions](#frequently-asked-questions) for common issues.
Copy to clipboard
5. Accessibility Considerations
Include optional title attributes to provide additional context for screen readers and users navigating with assistive technologies. Titles appear as tooltips when hovering over links.
// Adding titles improves accessibility
Visit our [documentation hub](https://docs.codecademy.com ‘Comprehensive guides and tutorials’) for detailed information.
Copy to clipboard
How to Format Markdown Links
1. Inline Link Formatting
The standard inline format places the URL directly after the link text, making it immediately visible in the source document.
// Basic inline link structure
[Link Text](URL)
// With optional title
[Link Text](URL ‘Title Text’)
// Real examples
Check out [Codecademy](https://www.codecademy.com) for online courses.
Visit our [Python course](https://www.codecademy.com/learn/learn-python-3 ‘Learn Python programming’) today.
Copy to clipboard
2. Automatic URL Linking
URLs can be automatically converted to clickable links by enclosing them in angle brackets, useful for displaying the full URL as the link text.
// Automatic linking with angle brackets
<contact@codecademy.com>
// These render as clickable links showing the full URL
Copy to clipboard
3. Email Address Linking
Email addresses follow the same pattern as URL links, creating
mailto:
links automatically when enclosed in angle brackets.// Email linking formats
Send questions to <support@codecademy.com>
Contact our [support team](mailto:support@codecademy.com ‘Get help with your account’)
Copy to clipboard
4. Linking to Images and Files
Links can point to various file types including images, documents, and downloadable resources.
// Link to downloadable files
Download the [course syllabus](https://example.com/files/syllabus.pdf ‘PDF document’)
View the [project diagram](https://example.com/images/architecture.png ‘System architecture overview’)
Copy to clipboard
5. Multi-line Link Formatting
For very long URLs, maintain readability by breaking reference definitions across multiple lines while keeping the link usage clean.
// Clean link usage
Read our comprehensive [style guide][style-guide] for best practices.
// Multi-line reference definition
[style-guide]: https://very-long-domain-name.com/documentation/
writing-style-guide/markdown-formatting-standards
“Complete Markdown Style Guide”
Copy to clipboard
Frequently Asked Questions
1. How do you hyperlink in Markdown?
Use square brackets around the link text followed by parentheses containing the URL:
[link text](URL)
. Optionally add a title in quotes after the URL.2. How do you Markdown a URL with spaces?
Either encode spaces as
%20
or enclose the entire URL in angle brackets:<URL with spaces>
. For file paths with spaces, use proper encoding or quotes.3. What is the permalink in Markdown?
A permalink is a permanent link to a specific section within a document, created using the
#
symbol followed by the section heading in lowercase with hyphens replacing spaces:[Section Link](#section-heading)
.All contributors
[
](https://codecademy.com/profiles/Affan.)
Preview: @Affan. 1 total contribution
@Affan.
1 total contribution
Checker Dense
[
](https://codecademy.com/profiles/Christine_Yang)
Preview: @Christine_Yang 271 total contributions
@Christine_Yang
271 total contributions
Checker Dense
[
](https://codecademy.com/profiles/Mikikiv)
Preview: @Mikikiv 9 total contributions
@Mikikiv
9 total contributions
Checker Dense
[
](https://codecademy.com/profiles/anli2)
Preview: @anli2 10 total contributions
@anli2
10 total contributions
Checker Dense
[
](https://codecademy.com/profiles/christian.dinh)
Preview: @christian.dinh 2487 total contributions
@christian.dinh
2487 total contributions
Checker Dense
Preview: Anonymous contributor 3120 total contributions
Anonymous contributor
3120 total contributions
Checker Dense
[
](https://codecademy.com/profiles/MamtaWardhani)
Preview: @MamtaWardhani 252 total contributions
@MamtaWardhani
252 total contributions
Checker Dense
Show more contributors
[
Affan.
](https://codecademy.com/profiles/Affan.)
[
Christine_Yang
](https://codecademy.com/profiles/Christine_Yang)
[
Mikikiv
](https://codecademy.com/profiles/Mikikiv)
[
anli2
](https://codecademy.com/profiles/anli2)
[
christian.dinh
](https://codecademy.com/profiles/christian.dinh)
Anonymous contributor
[
MamtaWardhani
](https://codecademy.com/profiles/MamtaWardhani)
Show more contributors
Contribute to Docs
- Learn more about how to get involved.
- Edit this page on GitHub to fix an error or make an improvement.
- Submit feedback to let us know how we can improve Docs.
Learn Markdown on Codecademy
[
](https://www.codecademy.com/learn/paths/front-end-engineer-career-path)
Footnote text goes here. ↩