Features

English version
中文版
日本語版

Do not modify this note. Thank you very much :smile:
If you want to say hello or play with something, please go to Playground

Introduction

HackMD is a realtime, multiplatform collaborative markdown note editor.
This means that you can write notes with other people on your desktop, tablet or even on the phone.
You can sign-in via Facebook, Twitter, GitHub, or Dropbox in the homepage.

Note that this service is still in an early stage, and thus still has some issues.
Please report new issues in GitHub.
If you need instant help, please send us a Facebook message.
Thank you very much!

Workspace

Modes

Desktop & Tablet

Edit: See only the editor.
View: See only the result.
Both: See both in split view.

Mobile

View: See only the result.
Edit: See only the editor.

Image Upload:

You can upload an image simply by clicking on the camera button .
Alternatively, you can drag-n-drop an image into the editor. Even pasting images is possible!
This will automatically upload the image to imgur, nothing to worry. :tada:

Share Notes:

If you want to share an editable note, just copy the URL.
If you want to share a read-only note, simply press publish button and copy the URL.

Save a Note:

Currently, you can save to Dropbox or save an .md file locally.

Import Notes:

Similarly to the save feature, you can also import an .md file from Dropbox ,
or import content from your clipboard , and that can parse some html which might be useful :smiley:

Permissions:

It is possible to change the access permission to a note through the little button on the top right of the view.
There are six possible options:

Freely: Anyone can edit this note.
Editable: A signed-in user can edit this note.
Limited: People have to sign-in to view and edit this note.
Locked: Anyone can view this note but only the owner can edit it.
Protected: People have to sign-in to view this note but only owner can edit.
Private: Only the owner can view and edit this note.

Only the owner of the note can change the note’s permissions.

Embed a Note:

Notes can be embedded as follows:

<iframe width="100%" height="500" src="https://hackmd.io/features" frameborder="0"></iframe>

Slide Mode:

You can use a special syntax to organize your note into slides.
After that, you can use the Slide Mode to make a presentation.
Visit the above link for details.

Book Mode:

You can make your notes into a book.
List your links in order or nest them.
Then use the Book Mode to make a collection.
Visit the above link for details.

View

Table of Contents:

You can look at the bottom right section of the view area, there is a ToC button .
Pressing that button will show you a current Table of Contents, and will highlight which section you’re at.
ToCs support up to three header levels.

Every header will automatically add a permalink on the right side.
You can hover and click to anchor on it.

Edit:

Shortcut Keys:

Just like Sublime text, which is pretty quick and convenient.

For more infomation, see here.

Auto-Complete:

This editor provides full auto-complete hints in markdown.

Title:

This will take the first level 1 header as the note title.

Tags:

Using tags as follows, the specified tags will show in your history.

tags: features cool updated

YAML Metadata

You can provide advanced note information to set the browser behavior (visit above link for details):

ToC:

Use the syntax [TOC] to embed table of content into your note.

Emoji

You can type any emoji like this :smile: :smiley: :cry: :wink:

See full emoji list here.

ToDo List:

Code Block:

We support many programming languages, use the auto complete function to see the entire list.

var s = "JavaScript syntax highlighting"; alert(s); function $initHighlight(block, cls) { try { if (cls.search(/\bno\-highlight\b/) != -1) return process(block, true, 0x0F) + ' class=""'; } catch (e) { /* handle exception */ } for (var i = 0 / 2; i < classes.length; i++) { if (checkCondition(classes[i]) === undefined) return /\d+[\s/]/g; } }

If you want line numbers, type = after specifying the code block languagues.
Also, you can specify the start line number.
Like below, the line number starts from 101:

var s = "JavaScript syntax highlighting"; alert(s); function $initHighlight(block, cls) { try { if (cls.search(/\bno\-highlight\b/) != -1) return process(block, true, 0x0F) + ' class=""'; } catch (e) { /* handle exception */ } for (var i = 0 / 2; i < classes.length; i++) { if (checkCondition(classes[i]) === undefined) return /\d+[\s/]/g; } }

Or you might want to continue the previous code block’s line number, use =+

var s = "JavaScript syntax highlighting"; alert(s);

Somtimes you have a super long text without breaks. It’s time to use ! to wrap your code.

When you’re a carpenter making a beautiful chest of drawers, you’re not going to use a piece of plywood on the back.

Blockquote Tags:

Using the syntax below to specifiy your name, time and color to vary the blockquotes.
ChengHan Wu Sun, Jun 28, 2015 9:59 PM

Even support the nest blockquotes!
ChengHan Wu Sun, Jun 28, 2015 10:00 PM

Externals

YouTube

Vimeo

Gist

SlideShare

26 Disruptive & Technology Trends 2016 - 2018 from Brian Solis

Speakerdeck

PDF

Caution: this might be blocked by your browser if not using an https URL.

MathJax

You can render LaTeX mathematical expressions using MathJax, as on math.stackexchange.com:

The Gamma function satisfying Γ(n)=(n1)!nN is via the Euler integral

x=b±b24ac2a.

Γ(z)=0tz1etdt.

More information about LaTeX mathematical expressions here.

UML Diagrams

Sequence Diagrams

You can render sequence diagrams like this:

Created with Raphaël 2.2.0AliceAliceBobBobHello Bob, how are you?Bob thinksI am good thanks!Alice respondsWhere have you been?

Flow Charts

Flow charts can be specified like this:

Created with Raphaël 2.2.0StartMy OperationlalalaYes or No?Endyesno

Graphviz







hierarchy



Headteacher

Headteacher



Deputy1

Deputy1



Headteacher->Deputy1





Deputy2

Deputy2



Headteacher->Deputy2





BusinessManager

BusinessManager



Headteacher->BusinessManager





Teacher1

Teacher1



Deputy1->Teacher1





Teacher2

Teacher2



Deputy1->Teacher2





ITManager

ITManager



BusinessManager->ITManager





Mermaid

w. 01w. 02w. 03w. 04w. 05w. 06w. 07A task           Another task     Task in sec      anther task      SectionAnotherA Gantt Diagram

Abc

Created with Raphaël 2.1.2Speed the PloughTrad.

More information about sequence diagrams syntax here.
More information about flow charts syntax here.
More information about graphviz syntax here
More information about mermaid syntax here
More information about abc syntax here

Alert Area

Yes :tada:

This is a message :mega:

Watch out :zap:

Oh No! :fire:

Typography

Headers

# h1 Heading
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading

Horizontal Rules




Typographic Replacements

Enable typographer option to see result.

© © ® ® ™ ™ § § ±

test… test… test… test?.. test!..

!!! ??? ,

Remarkable – awesome

“Smartypants, double quotes”

‘Smartypants, single quotes’

Emphasis

This is bold text

This is bold text

This is italic text

This is italic text

Deleted text

lulala

Superscript: 19th

Subscript: H2O

Inserted text

Marked text

Blockquotes

Blockquotes can also be nested…

…by using additional greater-than signs right next to each other…

…or with spaces between arrows.

Lists

Unordered

Ordered

  1. Lorem ipsum dolor sit amet

  2. Consectetur adipiscing elit

  3. Integer molestie lorem at massa

  4. You can use sequential numbers…

  5. …or keep all the numbers as 1.

  6. feafw

  7. 332

  8. 242

  9. 2552

  10. e2

Start numbering with offset:

  1. foo
  2. bar

Code

Inline code

Indented code

// Some comments
line 1 of code
line 2 of code
line 3 of code

Block code “fences”

Sample text here...

Syntax highlighting

var foo = function (bar) {
  return bar++;
};

console.log(foo(5));

Tables

Option Description
data path to data files to supply the data that will be passed into templates.
engine engine to be used for processing templates. Handlebars is the default.
ext extension to be used for dest files.

Right aligned columns

Option Description
data path to data files to supply the data that will be passed into templates.
engine engine to be used for processing templates. Handlebars is the default.
ext extension to be used for dest files.

Left aligned columns

Option Description
data path to data files to supply the data that will be passed into templates.
engine engine to be used for processing templates. Handlebars is the default.
ext extension to be used for dest files.

Center aligned columns

Option Description
data path to data files to supply the data that will be passed into templates.
engine engine to be used for processing templates. Handlebars is the default.
ext extension to be used for dest files.

link text
link with title
Autoconverted link https://github.com/nodeca/pica

Images



Like links, Images also have a footnote style syntax

With a reference later in the document defining the URL location:


Show the image with given size

Footnotes

Footnote 1 link[1].
Footnote 2 link[2].
Inline footnote[3] definition.
Duplicated footnote reference[2:1].

Definition Lists

Term 1

Definition 1
with lazy continuation.

Term 2 with inline markup

Definition 2

  { some code, part of Definition 2 }

Third paragraph of definition 2.

Compact style:

Term 1
Definition 1
Term 2
Definition 2a
Definition 2b

Abbreviations

This is an HTML abbreviation example.
It converts “HTML”, but keeps intact partial entries like “xxxHTMLyyy” and so on.


  1. Footnote can have markup
    and multiple paragraphs. ↩︎

  2. Footnote text. ↩︎ ↩︎

  3. Text of inline footnote ↩︎