HackMD
    • Sharing Link copied
    • /edit
    • View mode
      • Edit mode
      • View mode
      • Book mode
      • Slide mode
      Edit mode View mode Book mode Slide mode
    • Note Permission
    • Read
      • Only me
      • Signed-in users
      • Everyone
      Only me Signed-in users Everyone
    • Write
      • Only me
      • Signed-in users
      • Everyone
      Only me Signed-in users Everyone
    • More (Comment, Invitee)
    • Publishing
    • Commenting Enable
      Disabled Forbidden Owners Signed-in users Everyone
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
      • Everyone
    • Invitee
    • No invitee
    • Options
    • Versions
    • Transfer ownership
    • Delete this note
    • Template
    • Save as template
    • Insert from template
    • Export
    • Google Drive Export to Google Drive
    • Gist
    • Import
    • Google Drive Import from Google Drive
    • Gist
    • Clipboard
    • Download
    • Markdown
    • HTML
    • Raw HTML
Menu Sharing Help
Menu
Options
Versions Transfer ownership Delete this note
Export
Google Drive Export to Google Drive Gist
Import
Google Drive Import from Google Drive Gist Clipboard
Download
Markdown HTML Raw HTML
Back
Sharing
Sharing Link copied
/edit
View mode
  • Edit mode
  • View mode
  • Book mode
  • Slide mode
Edit mode View mode Book mode Slide mode
Note Permission
Read
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Write
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
More (Comment, Invitee)
Publishing
More (Comment, Invitee)
Commenting Enable
Disabled Forbidden Owners Signed-in users Everyone
Permission
Owners
  • Forbidden
  • Owners
  • Signed-in users
  • Everyone
Invitee
No invitee
   owned this note    owned this note      
Published Linked with
Like BookmarkBookmarked
Subscribed
  • Any changes
    Be notified of any changes
  • Mention me
    Be notified of mention me
  • Unsubscribe
Subscribe
# Markdown quick start guide Welcome to HackMD! :tada: This note will get you started on writing in Markdown in no time. You can try things out right in this note as a playground or leave it in your workspace as a cheatsheet. :::success :bulb: **Are you in Both Mode?** Before we get into the details, make sure you are in Both Mode. Please locate these three icons at the top of HackMD, with which you can toggle Edit/Both/View mode (from left to right). ![](https://hackmd.io/_uploads/BJ4echUst.png) Let's set it to Both Mode, so that you can take notes in Markdown in the left pane and see how it renders in the right pane. ::: Writing in Markdown is easy. It's just **using plaintext to format your text**. Here are some Markdown elements that you may find useful. Add them to your writings to give them nice and helpful structures. ## Frequently used elements ```python=9 print('Hello, world!') # See if you can set arbitrary line number or # change syntax highlighting for different language # in this code block. ``` - unordered list 1. ordered list - [ ] task > quote [Link](https://hackmd.io/c/tutorials) ## Styles of text **bold** _italics_ `literals` ~~strikethrough~~ ==highlight== 21^th^ Centuary H~2~O ## Image ![HackMD logo](https://presskit.hackmd.io/Default/HackMD_LOGO_vertical_white.png =200x200) 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 →](https://hackmd.io/s/features#Image-Upload). ## 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 <kbd>Enter</kbd> or <kbd>Return </kbd>) 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. <img style="display:block;margin:48px auto;padding:1px;border:1px #eee;width:100%;" src="https://hackmd.io/_uploads/Sypi9dluY.png" /> [Learn more about table tool here →](https://hackmd.io/c/tutorials/%2Fs%2Fhow-to-create-table) ## 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\theta } = \cos \theta \pm i\sin \theta $$ ### Draw UML diagrams to aid communication ```mermaid graph LR Work --> flow -- like --> this ``` HackMD supports many other UML diagrams. [Read more →](https://hackmd.io/c/tutorials/%2Fs%2Ffeatures#UML-Diagrams) ### Table of Content You can type `[toc]` to add a table of content of your note as below: [toc] :::info :bulb: **Navigating Menu** You can bring up the table of contents by clicking the `☰` icon at the bottom-left of the View pane: <img style="display:block;margin:48px auto;padding:1px;border:1px #eee;width:50%;" src="https://hackmd.io/_uploads/SkV-qOgOF.gif" /> ::: ### Admonitions Use these text boxes to emphasize important ideas. Can you change those emojis? :::warning :warning: Warnings ::: :::danger :radioactive_sign: Danger ::: :::info :information_source: Info ::: :::success :thumbsup: 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: 1. You can **focus on the content** as you write and leave styling and structures for later. 2. 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](https://hackmd.io/c/tutorials/%2Fs%2Ftutorials), you will find detailed guides to all main features of HackMD that boost your productivity. You will even learn how to [publish](https://hackmd.io/c/tutorials/%2Fs%2Fhow-to-publish-note) a [book](https://hackmd.io/c/tutorials/%2Fs%2Fhow-to-create-book)! :100: Feel free to ping us for questions: - :mailbox: support@hackmd.io - Mention `@hackmdio` on [Twitter](https://twitter.com/hackmdio)

Import from clipboard

Advanced permission required

Your current role can only read. Ask the system administrator to acquire write and comment permission.

This team is disabled

Sorry, this team is disabled. You can't edit this note.

This note is locked

Sorry, only owner can edit this note.

Reach the limit

Sorry, you've reached the max length this note can be.
Please reduce the content or divide it to more notes, thank you!

Import from Gist

Import from Snippet

or

Export to Snippet

Are you sure?

Do you really want to delete this note?
All users will lost their connection.

Create a note from template

Create a note from template

Oops...
This template has been removed or transferred.


Upgrade

All
  • All
  • Team
No template.

Create a template


Upgrade

Delete template

Do you really want to delete this template?

This page need refresh

You have an incompatible client version.
Refresh to update.
New version available!
See releases notes here
Refresh to enjoy new features.
Your user state has changed.
Refresh to load new user state.

Sign in

Forgot password

or

Sign in via GitHub

New to HackMD? Sign up

Help

  • English
  • 中文
  • 日本語

Documents

Tutorials

Book Mode Tutorial

Slide Example

YAML Metadata

Resources

Releases

Blog

Policy

Terms

Privacy

Cheatsheet

Syntax Example Reference
# Header Header 基本排版
- Unordered List
  • Unordered List
1. Ordered List
  1. Ordered List
- [ ] Todo List
  • Todo List
> Blockquote
Blockquote
**Bold font** Bold font
*Italics font* Italics font
~~Strikethrough~~ Strikethrough
19^th^ 19th
H~2~O H2O
++Inserted text++ Inserted text
==Marked text== Marked text
[link text](https:// "title") Link
![image alt](https:// "title") Image
`Code` Code 在筆記中貼入程式碼
```javascript
var i = 0;
```
var i = 0;
:smile: :smile: Emoji list
{%youtube youtube_id %} Externals
$L^aT_eX$ LaTeX
:::info
This is a alert area.
:::

This is a alert area.

Versions

Versions

Upgrade now

Version named by    

More Less
  • Edit
  • Delete

Note content is identical to the latest version.
Compare with
    Choose a version
    No search result
    Version not found

Feedback

Submission failed, please try again

Thanks for your support.

On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

Please give us some advice and help us improve HackMD.

 

Thanks for your feedback

Remove version name

Do you want to remove this version name and description?

Transfer ownership

Transfer to
    Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.