Markdown quick start guide

Welcome to HackMD!

Image Not Showing Possible Reasons

The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported

Frequently used elements




  print('Hello, world!')
  # See if you can set arbitrary line number or 
  # change syntax highlighting for different language
  # in this code block.

unordered list

ordered list

task

quote

Link

Styles of text

bold

italics

literals

~~strikethrough~~

highlight

21^th Centuary

H₂O

Image

Image Not Showing Possible Reasons

The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported

Learn More →

Just drag and drop an image anywhere in the editor, HackMD will render it for you.

You can change the size of the above image. See how →.

Headers

Put # at the beginning of a line, it becomes a header. Three #s creates a level 3 header, like this:

A Level 3 Header

Paragraph

As intuitive as it is, it's worth mentioning that leaving an empty line (by pressing Enter or Return ) lets you separate paragraphes.

Table

Column 1	Column 2	Column 3
Some	thing	nice
Text	Text	Text

Drawing tables with Markdown can be messy, so we created a tool to boost your productivity. Click on any cell in the table above and note the table tool appears in the toolbar on top of the editor changes.

Image Not Showing Possible Reasons

The image was uploaded to a note which you don't have access to
The note which the image was originally uploaded to has been deleted

Learn More →

Learn more about table tool here →

Extensions

Although the following extensions are not included in regular Markdown, they are widely accepted as useful elements of documentations.

Humans can read them rather easily, so feel free to use them in your notes.

Write formulas with MathJax

e^{\pm i θ} = \cos θ \pm i \sin θ

Draw UML diagrams to aid communication

HackMD supports many other UML diagrams. Read more →

Table of Content

You can type [toc] to add a table of content of your note as below:

Markdown quick start guide
Why Markdown?
Further Questions

Image Not Showing Possible Reasons

The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported

Learn More →

Navigating Menu

You can bring up the table of contents by clicking the ☰ icon at the bottom-left of the View pane:

Image Not Showing Possible Reasons

The image was uploaded to a note which you don't have access to
The note which the image was originally uploaded to has been deleted

Learn More →

Admonitions

Use these text boxes to emphasize important ideas. Can you change those emojis?

Image Not Showing Possible Reasons

The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported

Learn More →

Warnings

Image Not Showing Possible Reasons

The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported

Learn More →

Danger

Image Not Showing Possible Reasons

The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported

Learn More →

Info

Image Not Showing Possible Reasons

The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported

Learn More →

Success

Why Markdown?

Markdown describes the structure of the content explicitly with plain text, almost like writing in 'code', while keeping it human readable. This has two major advantages:

You can focus on the content as you write and leave styling and structures for later.
Writing in plaintext means your content is portable to any platform (device, operating system, or app). It may look somewhat different in each rendering, yet the content is all the same and no vendor lock-in.

Further Questions

In our tutorial book, you will find detailed guides to all main features of HackMD that boost your productivity. You will even learn how to publish a book!

Image Not Showing Possible Reasons

The image file may be corrupted
The server hosting the image is unavailable
The image path is incorrect
The image format is not supported

Learn More →

Feel free to ping us for questions:

Image Not Showing Possible Reasons
- The image file may be corrupted
- The server hosting the image is unavailable
- The image path is incorrect
- The image format is not supported
Learn More →
support@hackmd.io
Mention @hackmdio on Twitter