mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-11-26 11:43:59 -05:00
Update features.md
This commit is contained in:
parent
7725f7e6ca
commit
c639ed9487
1 changed files with 25 additions and 26 deletions
|
@ -4,11 +4,11 @@ Features
|
||||||
Introduction
|
Introduction
|
||||||
===
|
===
|
||||||
<i class="fa fa-file-text"></i> **HackMD** is a realtime, multiplatform collaborative markdown note editor.
|
<i class="fa fa-file-text"></i> **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**.
|
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](/)**.
|
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](https://github.com/hackmdio/hackmd/issues?q=is%3Aopen+is%3Aissue+label%3Abug) and might crash.
|
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 issues in [GitHub](https://github.com/hackmdio/hackmd/issues/new).
|
Please report new issues in [GitHub](https://github.com/hackmdio/hackmd/issues/new).
|
||||||
If you need instant help, please send us a [Facebook message](https://www.facebook.com/messages/866415986748945).
|
If you need instant help, please send us a [Facebook message](https://www.facebook.com/messages/866415986748945).
|
||||||
**Thank you very much!**
|
**Thank you very much!**
|
||||||
|
|
||||||
|
@ -26,50 +26,49 @@ Workspace
|
||||||
<i class="fa fa-toggle-on fa-fw"></i> View: See only the result.
|
<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.
|
<i class="fa fa-toggle-off fa-fw"></i> Edit: See only the editor.
|
||||||
|
|
||||||
## Upload image
|
## Upload Images:
|
||||||
You can simply press the camera button <i class="fa fa-camera"></i>.
|
You can simply press the camera button <i class="fa fa-camera"></i>.
|
||||||
Or **drag-n-drop** image in editor, even **paste** image works!
|
Or **drag-n-drop** image in editor, even **pasting** images is possible!
|
||||||
It will automatically upload to **[imgur](http://imgur.com)**, nothing to worry :tada:
|
This will automatically upload the image to **[imgur](http://imgur.com)**, nothing to worry :tada:
|
||||||
![](https://i.imgur.com/9cgQVqD.png)
|
![](https://i.imgur.com/9cgQVqD.png)
|
||||||
|
|
||||||
## Share note
|
## Share Notes:
|
||||||
If you want to share a **editable** note, just copy the url.
|
If you want to share a **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.
|
If you want to share a **read-only** note, simply press share button <i class="fa fa-share-alt"></i> and copy the url.
|
||||||
|
|
||||||
## Save
|
## Save:
|
||||||
Currently, you can save to **Dropbox** <i class="fa fa-dropbox"></i> or save as **.md** <i class="fa fa-file-text"></i> to local.
|
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.
|
||||||
|
|
||||||
## Import
|
## Import:
|
||||||
Like save feature, you can also import **.md** from **Dropbox** <i class="fa fa-dropbox"></i>.
|
Similarly to the _save_ feature, you can also import an `.md` file from **Dropbox** <i class="fa fa-dropbox"></i>,
|
||||||
Or import from your **Clipboard** <i class="fa fa-clipboard"></i>, and that can parse some **html** which might be useful :smiley:
|
or import content from your **clipboard** <i class="fa fa-clipboard"></i>, and that can parse some **html** which might be useful :smiley:
|
||||||
|
|
||||||
## Permission
|
## Permissions:
|
||||||
There is a little button on the top right of the view.
|
It is possible to change the access permission to anote through a little button on the top right of the view.
|
||||||
You can change the permission via theres options.
|
There are three possible options:
|
||||||
It might be one of below:
|
|
||||||
|
|
||||||
<i class="fa fa-leaf fa-fw"></i> Freely: Anyone can edit this note.
|
<i class="fa fa-leaf fa-fw"></i> **Freely**: Anyone can edit this note.
|
||||||
<i class="fa fa-pencil fa-fw"></i> Editable: Signed user can edit this note.
|
<i class="fa fa-pencil fa-fw"></i> **Editable**: Signed user can edit this note.
|
||||||
<i class="fa fa-lock fa-fw"></i> Locked: Only owner can edit this note.
|
<i class="fa fa-lock fa-fw"></i> **Locked**: Only owner can edit this note.
|
||||||
<i class="fa fa-hand-stop-o fa-fw"></i> Private: Only owner can view and edit this note.
|
<i class="fa fa-hand-stop-o fa-fw"></i> **Private**: Only owner can view and edit this note.
|
||||||
|
|
||||||
**Only the owner of the note can change the permission**
|
**Only the owner of the note can change the permission.**
|
||||||
|
|
||||||
## Embed
|
## Embed:
|
||||||
```xml
|
```xml
|
||||||
<iframe width="100%" height="500" src="https://hackmd.io/features" frameborder="0"></iframe>
|
<iframe width="100%" height="500" src="https://hackmd.io/features" frameborder="0"></iframe>
|
||||||
```
|
```
|
||||||
|
|
||||||
## [Slide Mode](./slide-example)
|
## [Slide Mode](./slide-example):
|
||||||
You can use some syntax to divide your note into slides.
|
You can use some syntax to divide your note into slides.
|
||||||
Then use **Slide Mode** <i class="fa fa-tv"></i> to made a presentation.
|
Then use **Slide Mode** <i class="fa fa-tv"></i> to made a presentation.
|
||||||
Visit above link for detail.
|
Visit above link for detail.
|
||||||
|
|
||||||
View
|
View
|
||||||
===
|
===
|
||||||
## Table of content
|
## Table of Contents:
|
||||||
You can look at bottom right place of the view area, there is a TOC button <i class="fa fa-bars"></i>.
|
You can look at bottom right place of the view area, there is a TOC button <i class="fa fa-bars"></i>.
|
||||||
Press that will show current table of content and will emphasis which your section on.
|
Pressing that will show you a current Table of Contents, and will highlight which your section is.
|
||||||
Support up to **three header levels**.
|
Support up to **three header levels**.
|
||||||
|
|
||||||
## Permalink
|
## Permalink
|
||||||
|
|
Loading…
Reference in a new issue