or
or
By clicking below, you agree to our terms of service.
New to HackMD? Sign up
Syntax | Example | Reference | |
---|---|---|---|
# Header | Header | 基本排版 | |
- Unordered List |
|
||
1. Ordered List |
|
||
- [ ] Todo List |
|
||
> Blockquote | Blockquote |
||
**Bold font** | Bold font | ||
*Italics font* | Italics font | ||
~~Strikethrough~~ | |||
19^th^ | 19th | ||
H~2~O | H2O | ||
++Inserted text++ | Inserted text | ||
==Marked text== | Marked text | ||
[link text](https:// "title") | Link | ||
 | Image | ||
`Code` | Code |
在筆記中貼入程式碼 | |
```javascript var i = 0; ``` |
|
||
:smile: | ![]() |
Emoji list | |
{%youtube youtube_id %} | Externals | ||
$L^aT_eX$ | LaTeX | ||
:::info This is a alert area. ::: |
This is a alert area. |
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.
Do you want to remove this version name and description?
Syncing
xxxxxxxxxx
User Notes API
Caution
This page of API documentation is deprecated. Please refer to the new Swagger Documentation instead.
Get a list of notes in the user's workspace
GET /notes
200
Get a note
GET /notes/:noteId
200
Create a note
POST /notes
body (optional) [application/json]
owner
,signed_in
,guest
owner
,signed_in
,guest
disabled
,forbidden
,owners
,signed_in_users
,everyone
Success Response
201
- The image file may be corrupted
- The server hosting the image is unavailable
- The image path is incorrect
- The image format is not supported
Learn More →Title
fieldAs for now, the title of a note is derived from the content, thus the behavior of "title" field may need further explanation.
---\ntitle: abc\n---
), then it will be the title of the note.- The image file may be corrupted
- The server hosting the image is unavailable
- The image path is incorrect
- The image format is not supported
Learn More →readPermission
andwritePermission
field must be provided at the same time.writePermission
must be stricter thanreadPermission
field. For example, asigned_in
user readable note, you can setowner
orsigned_in
writable permission, but you can't setguest
writable permission for that note.Update a note
PATCH /notes/:noteId
owner
,signed_in
,guest
owner
,signed_in
,guest
Delete a note
DELETE /notes/:noteId
Get a history of read notes
GET /history
Upload attachments to a note (To be announced)
POST /notes/:noteId/upload
file: xxx