hedgedoc/public/docs/features.md

519 lines
13 KiB
Markdown
Raw Normal View History

2015-05-04 03:53:29 -04:00
Features
===
Introduction
===
2016-09-09 16:08:17 -04:00
<i class="fa fa-file-text"></i> **HackMD** is a realtime, multiplatform collaborative markdown note editor.
2016-09-09 16:42:12 -04:00
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_](/).
2016-09-09 16:42:12 -04:00
Note that this service is still in an early stage, and thus still has some [_issues_](https://github.com/hackmdio/hackmd/issues?q=is%3Aopen+is%3Aissue+label%3Abug).
Please report new issues in [GitHub](https://github.com/hackmdio/hackmd/issues/new).
2016-09-09 16:08:17 -04:00
If you need instant help, please send us a [Facebook message](https://www.facebook.com/messages/866415986748945).
**Thank you very much!**
Workspace
===
## Modes
**Desktop & Tablet**
<i class="fa fa-edit fa-fw"></i> Edit: See only the editor.
<i class="fa fa-eye fa-fw"></i> View: See only the result.
<i class="fa fa-columns fa-fw"></i> Both: See both in split view.
**Mobile**
<i class="fa fa-toggle-on fa-fw"></i> View: See only the result.
<i class="fa fa-toggle-off fa-fw"></i> Edit: See only the editor.
2016-09-11 17:19:05 -04:00
## Image Upload:
You can upload an image simply by clicking on the camera button <i class="fa fa-camera"></i>.
Alternatively, you can **drag-n-drop** an image into the editor. Even **pasting** images is possible!
2016-09-09 17:44:20 -04:00
This will automatically upload the image to **[imgur](http://imgur.com)**, nothing to worry. :tada:
![](https://i.imgur.com/9cgQVqD.png)
2016-09-09 16:42:12 -04:00
## Share Notes:
2016-09-11 17:19:05 -04:00
If you want to share an **editable** note, just copy the URL.
If you want to share a **read-only** note, simply press share button <i class="fa fa-share-alt"></i> and copy the URL.
2016-09-11 17:19:05 -04:00
## Save a Note:
2016-09-09 16:42:12 -04:00
Currently, you can save to **Dropbox** <i class="fa fa-dropbox"></i> or save an `.md` file <i class="fa fa-file-text"></i> locally.
2016-09-11 17:19:05 -04:00
## Import Notes:
2016-09-09 16:42:12 -04:00
Similarly to the _save_ feature, you can also import an `.md` file from **Dropbox** <i class="fa fa-dropbox"></i>,
or import content from your **clipboard** <i class="fa fa-clipboard"></i>, and that can parse some **html** which might be useful :smiley:
2016-09-09 16:42:12 -04:00
## Permissions:
2016-09-11 17:19:05 -04:00
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:
2016-09-09 16:42:12 -04:00
<i class="fa fa-leaf fa-fw"></i> **Freely**: Anyone can edit this note.
2016-09-09 17:44:20 -04:00
<i class="fa fa-pencil fa-fw"></i> **Editable**: A signed-in user can edit this note.
<i class="fa fa-lock fa-fw"></i> **Locked**: Only the owner can edit this note.
<i class="fa fa-hand-stop-o fa-fw"></i> **Private**: Only the owner can view and edit this note.
2016-09-09 17:44:20 -04:00
**Only the owner of the note can change the note's permissions.**
2016-09-11 17:19:05 -04:00
## Embed a Note:
Notes can be embedded as follows:
```xml
<iframe width="100%" height="500" src="https://hackmd.io/features" frameborder="0"></iframe>
2015-05-04 03:53:29 -04:00
```
2016-09-09 16:42:12 -04:00
## [Slide Mode](./slide-example):
2016-09-09 17:44:20 -04:00
You can use a special syntax to organize your note into slides.
After that, you can use the **Slide Mode** <i class="fa fa-tv"></i> to make a presentation.
Visit the above link for details.
View
===
2016-09-09 16:42:12 -04:00
## Table of Contents:
2016-09-11 17:19:05 -04:00
You can look at the bottom right section of the view area, there is a _ToC_ button <i class="fa fa-bars"></i>.
2016-09-09 17:44:20 -04:00
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**.
## Permalink
Every header will automatically add a permalink on the right side.
You can hover and click <i class="fa fa-chain"></i> to anchor on it.
2016-09-09 17:44:20 -04:00
Edit:
===
2016-09-09 17:44:20 -04:00
## Shortcut Keys:
Just like Sublime text, which is pretty quick and convenient.
> For more infomation, see [here](https://codemirror.net/demo/sublime.html).
2016-09-09 17:44:20 -04:00
## Auto-Complete:
2016-09-11 17:19:05 -04:00
This editor provides full auto-complete hints in markdown.
2016-09-09 17:44:20 -04:00
- Emojis: type `:` to show hints.
- Code blocks: type ` ``` ` and plus a character to show hint. <i hidden>```</i>
- Headers: type `#` to show hint.
- Referrals: type `[]` to show hint.
- Externals: type `{}` to show hint.
- Images: type `!` to show hint.
2016-09-09 17:44:20 -04:00
## Title:
This will take the first **level 1 header** as the note title.
2016-09-09 17:44:20 -04:00
## Tags:
2016-09-11 17:19:05 -04:00
Using tags as follows, the specified tags will show in your **history**.
###### tags: `features` `cool` `updated`
2016-09-11 17:19:05 -04:00
## [YAML Metadata](./yaml-metadata)
You can provide advanced note information to set the browser behavior (visit above link for details):
- robots: set web robots meta
2016-09-09 17:44:20 -04:00
- lang: set browser language
- dir: set text direction
2016-09-11 17:19:05 -04:00
- breaks: set to use line breaks
2016-08-14 23:28:05 -04:00
- GA: set to use Google Analytics
- disqus: set to use Disqus
2016-09-09 17:44:20 -04:00
- slideOptions: setup slide mode options
2016-08-14 23:28:05 -04:00
2016-09-09 17:44:20 -04:00
## ToC:
2016-08-14 23:28:05 -04:00
Use the syntax `[TOC]` to embed table of content into your note.
[TOC]
## Emoji
You can type any emoji like this :smile: :smiley: :cry: :wink:
2016-09-09 17:44:20 -04:00
> See full emoji list [here](http://www.emoji-cheat-sheet.com/).
2016-09-09 17:44:20 -04:00
## ToDo List:
- [ ] ToDos
2016-09-11 17:19:05 -04:00
- [x] Buy some salad
- [ ] Brush teeth
- [x] Drink some water
2016-09-09 17:44:20 -04:00
## Code Block:
2016-09-11 17:19:05 -04:00
We support many programming languages, use the auto complete function to see the entire list.
```javascript=
2015-05-04 03:53:29 -04:00
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;
}
}
```
2016-09-09 17:44:20 -04:00
> 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:
```javascript=101
2015-05-04 03:53:29 -04:00
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;
}
}
```
2016-09-09 17:44:20 -04:00
> Or you might want to continue the previous code block's line number, use `=+`
2015-05-04 03:53:29 -04:00
```javascript=+
var s = "JavaScript syntax highlighting";
alert(s);
```
2015-05-04 03:53:29 -04:00
2016-09-09 17:44:20 -04:00
### Blockquote Tags:
2016-09-11 17:19:05 -04:00
> Using the syntax below to specifiy your **name, time and color** to vary the blockquotes.
> [name=ChengHan Wu] [time=Sun, Jun 28, 2015 9:59 PM] [color=#907bf7]
> > Even support the nest blockquotes!
> > [name=ChengHan Wu] [time=Sun, Jun 28, 2015 10:00 PM] [color=red]
2015-05-04 03:53:29 -04:00
## Externals
2015-05-04 03:53:29 -04:00
2016-09-11 17:19:05 -04:00
### YouTube
{%youtube 1G4isv_Fylg %}
2015-05-04 03:53:29 -04:00
### Vimeo
{%vimeo 124148255 %}
2015-05-04 03:53:29 -04:00
### Gist
{%gist schacon/4277%}
2015-05-04 03:53:29 -04:00
### SlideShare
{%slideshare briansolis/26-disruptive-technology-trends-2016-2018-56796196 %}
2015-05-04 03:53:29 -04:00
### Speakerdeck
{%speakerdeck sugarenia/xxlcss-how-to-scale-css-and-keep-your-sanity %}
2015-05-04 03:53:29 -04:00
2016-06-21 09:44:06 -04:00
### PDF
2016-09-11 17:19:05 -04:00
**Caution: this might be blocked by your browser if not using an `https` URL.**
2016-06-21 09:44:06 -04:00
{%pdf https://papers.nips.cc/paper/5346-sequence-to-sequence-learning-with-neural-networks.pdf %}
## MathJax
2015-05-04 03:53:29 -04:00
You can render *LaTeX* mathematical expressions using **MathJax**, as on [math.stackexchange.com](http://math.stackexchange.com/):
2015-05-04 03:53:29 -04:00
The *Gamma function* satisfying $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$ is via the Euler integral
2015-05-04 03:53:29 -04:00
$$
x = {-b \pm \sqrt{b^2-4ac} \over 2a}.
$$
2015-05-04 03:53:29 -04:00
$$
\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.
$$
> More information about **LaTeX** mathematical expressions [here](http://meta.math.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference).
2016-09-11 17:19:05 -04:00
## UML Diagrams
2016-09-11 17:19:05 -04:00
### Sequence Diagrams
You can render sequence diagrams like this:
2015-05-04 03:53:29 -04:00
```sequence
Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!
Note left of Alice: Alice responds
Alice->Bob: Where have you been?
```
2016-09-11 17:19:05 -04:00
### Flow Charts
2016-09-11 17:19:05 -04:00
Flow charts can be specified like this:
```flow
st=>start: Start
e=>end: End
op=>operation: My Operation
op2=>operation: lalala
cond=>condition: Yes or No?
2015-05-04 03:53:29 -04:00
st->op->op2->cond
cond(yes)->e
cond(no)->op2
```
2015-05-04 03:53:29 -04:00
### Graphviz
```graphviz
digraph hierarchy {
2015-05-04 03:53:29 -04:00
nodesep=1.0 // increases the separation between nodes
node [color=Red,fontname=Courier,shape=box] //All nodes will this shape and colour
edge [color=Blue, style=dashed] //All the lines look like this
2015-05-04 03:53:29 -04:00
Headteacher->{Deputy1 Deputy2 BusinessManager}
Deputy1->{Teacher1 Teacher2}
BusinessManager->ITManager
{rank=same;ITManager Teacher1 Teacher2} // Put them on the same level
}
```
2015-05-04 03:53:29 -04:00
### Mermaid
```mermaid
gantt
title A Gantt Diagram
section Section
A task :a1, 2014-01-01, 30d
Another task :after a1 , 20d
section Another
Task in sec :2014-01-12 , 12d
anther task : 24d
```
2016-09-11 17:19:05 -04:00
> More information about **sequence diagrams** syntax [here](http://bramp.github.io/js-sequence-diagrams/).
> More information about **flow charts** syntax [here](http://adrai.github.io/flowchart.js/).
> More information about **graphviz** syntax [here](http://www.tonyballantyne.com/graphs.html)
> More information about **mermaid** syntax [here](http://knsv.github.io/mermaid)
2016-09-11 17:19:05 -04:00
Alert Area
---
:::success
Yes :tada:
:::
:::info
This is a message :mega:
:::
:::warning
Watch out :zap:
:::
:::danger
2016-09-11 17:19:05 -04:00
Oh No! :fire:
:::
## Typography
### Headers
```
2015-05-04 03:53:29 -04:00
# h1 Heading
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading
```
2015-05-04 03:53:29 -04:00
2016-09-11 17:19:05 -04:00
### Horizontal Rules
2015-05-04 03:53:29 -04:00
___
---
***
2016-09-11 17:19:05 -04:00
### Typographic Replacements
2015-05-04 03:53:29 -04:00
Enable typographer option to see result.
(c) (C) (r) (R) (tm) (TM) (p) (P) +-
test.. test... test..... test?..... test!....
!!!!!! ???? ,,
Remarkable -- awesome
"Smartypants, double quotes"
'Smartypants, single quotes'
### Emphasis
2015-05-04 03:53:29 -04:00
**This is bold text**
__This is bold text__
*This is italic text*
_This is italic text_
~~Deleted text~~
lu~lala~
2015-05-04 03:53:29 -04:00
Superscript: 19^th^
Subscript: H~2~O
++Inserted text++
==Marked text==
### Blockquotes
2015-05-04 03:53:29 -04:00
> Blockquotes can also be nested...
>> ...by using additional greater-than signs right next to each other...
> > > ...or with spaces between arrows.
2015-05-04 03:53:29 -04:00
### Lists
2015-05-04 03:53:29 -04:00
#### Unordered
2015-05-04 03:53:29 -04:00
+ Create a list by starting a line with `+`, `-`, or `*`
+ Sub-lists are made by indenting 2 spaces:
- Marker character change forces new list start:
* Ac tristique libero volutpat at
+ Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
+ Very easy!
#### Ordered
2015-05-04 03:53:29 -04:00
1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit
3. Integer molestie lorem at massa
1. You can use sequential numbers...
1. ...or keep all the numbers as `1.`
1. feafw
2. 332
3. 242
4. 2552
1. e2
2015-05-04 03:53:29 -04:00
Start numbering with offset:
57. foo
1. bar
### Code
2015-05-04 03:53:29 -04:00
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
``` js
var foo = function (bar) {
return bar++;
};
console.log(foo(5));
```
### Tables
2015-05-04 03:53:29 -04:00
| 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
2015-05-04 03:53:29 -04:00
| 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. |
2015-05-04 03:53:29 -04:00
Center aligned columns
2015-05-04 03:53:29 -04:00
| 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. |
2015-05-04 03:53:29 -04:00
### Links
[link text](http://dev.nodeca.com)
[link with title](http://nodeca.github.io/pica/demo/ "title text!")
Autoconverted link https://github.com/nodeca/pica
2015-05-04 03:53:29 -04:00
### Images
2015-05-04 03:53:29 -04:00
![Minion](https://octodex.github.com/images/minion.png)
![Stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")
Like links, Images also have a footnote style syntax
![Alt text][id]
With a reference later in the document defining the URL location:
[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
![Minion](https://octodex.github.com/images/minion.png =200x200)
Show the image with given size
2015-05-04 03:53:29 -04:00
### Footnotes
2015-05-04 03:53:29 -04:00
Footnote 1 link[^first].
Footnote 2 link[^second].
Inline footnote^[Text of inline footnote] definition.
Duplicated footnote reference[^second].
[^first]: Footnote **can have markup**
and multiple paragraphs.
[^second]: Footnote text.
2016-09-11 17:19:05 -04:00
### Definition Lists
2015-05-04 03:53:29 -04:00
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
2015-05-04 03:53:29 -04:00
2016-09-11 17:19:05 -04:00
This is an HTML abbreviation example.
It converts "HTML", but keeps intact partial entries like "xxxHTMLyyy" and so on.
2015-05-04 03:53:29 -04:00
2016-09-09 16:08:17 -04:00
*[HTML]: Hyper Text Markup Language