CodiMD is a real-time, multi-platform 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 multiple auth providers like Facebook, Twitter, GitHub and many more on the homepage.
If you experience any issues, feel free to report it on GitHub.
Or meet us on Gitter for dev-talk and interactive help.
Thank you very much!
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.
When you are tired of a white screen and like a night mode, click on the little moon and turn on the night view of CodiMD.
The editor view, which is in night mode by default, can also be toggled between night and day view using the the little sun.
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, Amazon S3, Minio or local filesystem, nothing to worry about.
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.
Currently, you can save to Dropbox or save an .md
file locally.
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
It is possible to change the access permission to a note through the little button on the top right of the view.
There are four possible options:
Owner read/write | Signed-in read | Signed-in write | Guest read | Guest write | |
---|---|---|---|---|---|
Freely | ✔ | ✔ | ✔ | ✔ | ✔ |
Editable | ✔ | ✔ | ✔ | ✔ | ✖ |
Limited | ✔ | ✔ | ✔ | ✖ | ✖ |
Locked | ✔ | ✔ | ✖ | ✔ | ✖ |
Protected | ✔ | ✔ | ✖ | ✖ | ✖ |
Private | ✔ | ✖ | ✖ | ✖ | ✖ |
Only the owner of the note can change the note’s permissions.
Notes can be embedded as follows:
<iframe width="100%" height="500" src="https://hackmd.io/features"></iframe>
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.
To switch the editor into slide mode, set the document type to slide
.
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 five header levels, the default is set to three. The maxLevel can be set for each note by using
YAML Metadata
Every header will automatically add a permalink on the right side.
You can hover and click to anchor on it.
You can look in the bottom right section of the editor area, there you’ll find a button with sublime
on it.
When you click it, you can select 3 editor modes:
The shortcut keys depend on your selected editor mode. By default they are just like Sublime text, which is pretty quick and convenient.
For more information, see here.
For emacs:
For more information, see here.
For vim:
For more information, see here.
This editor provides full auto-complete hints in markdown.
:
to show hints.```
and plus a character to show hint. ```#
to show hint.[]
to show hint.{}
to show hint.!
to show hint.This will take the first level 1 header as the note title.
Using tags as follows, the specified tags will show in your history.
features
cool
updated
You can provide advanced note information to set the browser behavior (visit above link for details):
Use the syntax [TOC]
to embed table of content into your note. By default, three header levels are displayed. This can also be specified by using YAML Metadata.
You can also specify the number of header levels by specifying the maxLevel
like this: [TOC maxLevel=1]
You can type any emoji like this
See full emoji list here.
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.
Using the syntax below to specifiy your name, time and color to vary the blockquotes.
ChengHan Wu Sun, Jun 28, 2015 9:59 PMEven support the nest blockquotes!
ChengHan Wu Sun, Jun 28, 2015 10:00 PM
You can use write csv in the codeblock:
```csvpreview {header="true"}
firstName,lastName,email,phoneNumber
John,Doe,john@doe.com,0123456789
Jane,Doe,jane@doe.com,9876543210
James,Bond,james.bond@mi6.co.uk,0612345678
```
which rendered to:
firstName | lastName | phoneNumber | |
---|---|---|---|
John | Doe | john@doe.com | 0123456789 |
Jane | Doe | jane@doe.com | 9876543210 |
James | Bond | james.bond@mi6.co.uk | 0612345678 |
We use Papa Parse for parsing csv. The parsing option is given in braces: {}
, and multiple options are seperated by a space. e.g. {header="true" delimiter="."}
. Please read their documentation as reference.
require 'net/http'
require 'uri'
# /api/v1/:format/new
# /api/v1/:format/gists/:user
# /api/v1/:format/:gist_id
res = Net::HTTP.post_form(URI.parse('http://gist.github.com/api/v1/xml/new'),
{ 'files[file1.ab]' => 'CONTNETS',
'files[file2.ab]' => 'contents' })
puts res.body
<?xml version="1.0" encoding="UTF-8"?>
<gists type="array">
<gist>
<public type="boolean">true</public>
<description nil="true"></description>
<repo>4278</repo>
<created-at type="datetime">2008-08-06T13:30:32-07:00</created-at>
</gist>
</gists>
Caution: this might be blocked by your browser if not using an https
URL.
You can render LaTeX mathematical expressions using MathJax, as on math.stackexchange.com:
The Gamma function satisfying Γ(n)=(n−1)!∀n∈N is via the Euler integral
x=−b±√b2−4ac2a.
Γ(z)=∫∞0tz−1e−tdt.
More information about LaTeX mathematical expressions here.
You can render sequence diagrams like this:
Flow charts can be specified like this:
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
More information about plantuml syntax here
More information about vega syntax here
More information about fretboard syntax here
Yes
This is a message
Watch out
Oh No!
You found me
horizontal, 6 frets, with nut
# h1 Heading
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading
Enable typographer option to see result.
© © ® ® ™ ™ § § ±
test… test… test… test?.. test!..
!!! ??? ,
Remarkable – awesome
“Smartypants, double quotes”
‘Smartypants, single quotes’
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
ruby base
Blockquotes can also be nested…
…by using additional greater-than signs right next to each other…
…or with spaces between arrows.
+
, -
, or *
Lorem ipsum dolor sit amet
Consectetur adipiscing elit
Integer molestie lorem at massa
You can use sequential numbers…
…or keep all the numbers as 1.
feafw
332
242
2552
e2
Start numbering with offset:
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));
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
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
Footnote 1 link[1].
Footnote 2 link[2].
Inline footnote[3] definition.
Duplicated footnote reference[2:1].
Definition 1
with lazy continuation.
Definition 2
{ some code, part of Definition 2 }
Third paragraph of definition 2.
Compact style:
This is an HTML abbreviation example.
It converts “HTML”, but keeps intact partial entries like “xxxHTMLyyy” and so on.