picture: image/dropbox_geoblast.jpg tags: [Markdown, 模板] date: 2019-03-05

分享幾個常用的 Markdown 模板

Markdown 在我們日常應用中基本上已經取代其他文本工具了，但和其他文本編輯器不同的是，沒有太多新建項目模板，前幾天看到Dropbox Paper上

面的幾個 Markdown 模板，做得很不錯，我將其整理下來，並附上常用的幾個Markdown分檔分享。

模板包含:

頭腦風暴
會議記錄
項目計劃
RestAPI文檔

最後，附上英文文檔源碼

英文文檔源碼

頭腦風暴

源碼

# 💡頭腦風暴： 添加主題

| **目標**  | 您想要什麼樣的想法？              |
| ------- | ----------------------- |
| **參與者** | @提及您自己和其他人              |
| **相關**  | - 🔗 [插入一些文檔或鏈接]() |

## 靈感

使用您點擊“返回”時顯示的工具欄來添加圖片、視頻等

## 想法

向團隊提出一個問題，讓事情順利進行

----------
## 後續步驟

- [ ] 打破常規 @某人
- [ ] 從待辦到完成 @某人

顯示效果 (已調整縮進)

💡頭腦風暴：添加主題

目標	您想要什麼樣的想法？
參與者	@提及您自己和其他人
相關	-相關文檔１ `<br>`- 插入相關文檔

靈感

使用您點擊“返回”時顯示的工具欄來添加圖片、視頻等

想法

向團隊提出一個問題，讓事情順利進行

後續步驟

[ ] 打破常規 @某人
[ ] 從待辦到完成 @某人

會議記錄

源碼

# 🕘 會議記錄： 添加事件名稱

# 2019-03-02

****
## 與會者

@提及您自己並添加其他人

## 議程
- 會議議程

## 討論
- 我們實際討論的內容

## 操作項目

- [ ] 我們來完成這項任務 @某人

顯示效果 (已調整縮進)

🕘 會議記錄：添加事件名稱

2019-03-02

與會者

@提及您自己並添加其他人

議程

會議議程

討論

我們實際討論的內容

操作項目

[ ] 我們來完成這項任務 @某人

項目計劃

# 📋 項目計劃： 添加項目

| **說明** | 您有什麼想法？                 |
| ------ | ----------------------- |
| **狀態** | 提前 🌱 | 進行中 🔨 | 已完成 ⭐  |
| **團隊** | 身份: @某人<br>身份: @某人      |
| **相關** | - [相關文檔１](document1) <br>- [插入相關文檔](http://document) |

## 時間線

| 標題 | 日期(Deadline) | 已指派給 | 說明 |
| --- | :---------: | ------- | --- |
|     | 03.01-03.12 |         |     |

## 詳細信息

使用您點擊“返回”時顯示的工具欄來添加圖片、視頻等

## 待辦事項

- [ ] 我們將會完成這項任務 @某人
- [ ] 我們今天就來解決這項任務 @某人

顯示效果 (已調整縮進)

📋 項目計劃：添加項目

說明	您有什麼想法？
狀態	提前 🌱
團隊	身份: @某人`<br>`身份: @某人
相關	-相關文檔１ `<br>`- 插入相關文檔

時間線

標題	日期	已指派給	說明
	03.01-03.12

詳細信息

使用您點擊“返回”時顯示的工具欄來添加圖片、視頻等

待辦事項

[ ] 我們將會完成這項任務 @某人
[ ] 我們今天就來解決這項任務 @某人

RestAPI文檔

### The title of your rest api

Some description of your api

**Method:** POST

**Content-Type:** application/json

**Endpoint**

```bash
https://apis.example.com/v1/example

Request Body Payload

Property Name	Type	Description
name	string	the name of this model
admin	boolean	Whether the model is admin

Response Payload

Property Name	Type	Description
id	string	the id of the server
name	string	the name of this model
admin	boolean	Whether the model is admin

Sample request

curl 'https://apis.example.com/v1/example' \
-H 'Content-Type: application/json' \
-H 'Authorization: ${TOKEN}' \
-d \
'{
    "name": "test",
    "admin": true
}'

In the example above, you would replace ${TOKEN} with the generated Auth token, Refer: User Authorization .

A successful request is indicated by a 200 OK HTTP status code. The response contains id of your model

Sample response

{
  "id": "A163D1C8AA1FD43CAF521B74FC5A46BE",
  "name": "test",
  "admin": "true",
  "expiresIn": "3600"
}

Common error codes

invalid_argument: the [name] may be tool long for database
permission_denied: you may have no permission for this operation

Other errors you may need to refer to the global error code.


**顯示效果** (已調整縮進)

### The title of your rest api

Some description of your api

**Method:** POST

**Content-Type:** application/json

**Endpoint**

```bash
https://apis.example.com/v1/example

Request Body Payload

Property Name	Type	Description
name	string	the name of this model
admin	boolean	Whether the model is admin

Response Payload

Property Name	Type	Description
id	string	the id of the server
name	string	the name of this model
admin	boolean	Whether the model is admin

Sample request

curl 'https://apis.example.com/v1/example' \
-H 'Content-Type: application/json' \
-H 'Authorization: ${TOKEN}' \
-d \
'{
    "name": "test",
    "admin": true
}'

In the example above, you would replace ${TOKEN} with the generated Auth token, Refer: User Authorization .

A successful request is indicated by a 200 OK HTTP status code. The response contains id of your model

Sample response

{
  "id": "A163D1C8AA1FD43CAF521B74FC5A46BE",
  "name": "test",
  "admin": "true",
  "expiresIn": "3600"
}

Common error codes

invalid_argument: the [name] may be tool long for database
permission_denied: you may have no permission for this operation

Other errors you may need to refer to the global error code.

英文文檔源碼

Brainstorm

# 💡 Brainstorm: Add a topic

| **Goal**         | What kinds of ideas do you want?    |
| ---------------- | ----------------------------------- |
| **Participants** | @mention yourself and others        |
| **Related**      | - + (some Related documents ) |

## Inspiration

Add images, videos, and more by using the toolbar that appears when you hit return


## Ideas

Ask the group a question to get things flowing


----------
## Next steps
[ ] Think outside the box @someone
[ ] From to do to done @someone

Project plan

# 📋 Project plan: Add a project

| **Description** | What do you have in mind?                                                                                                                                |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| **Status**      | Early 🌱 | In progress 🔨 | Finished ⭐                                                                                                                   |
| **Team**        | Role: @someone<br>Role: @someone                                                                                                                         |
| **Related**     | - [document1](document1.md) <br>- [document2](http://document2.md) |

## Timeline
Title | Dates | Assigned to | Description
--- | --- | --- | ---
 | March 1, 2019 - March 6, 2019 |  | 
## Details

Add images, videos, and more by using the toolbar that appears when you hit return


## To-dos
[ ] We’ll get this done @someone
[ ] Let’s tackle this today @someone

Meeting notes*

# 🕘 Meeting notes: Add an event name

# Mar 2, 2019

****
## Attendees

@mention yourself and add others


## Agenda
- Stuff to talk about


## Discussion
- Stuff we actually talked about


## Action items
[ ] Let’s get this done @someone

REST API Templates

### The title of your rest api

Some description of your api

**Method:** POST

**Content-Type:** application/json

**Endpoint**

```bash
https://apis.example.com/v1/example

Request Body Payload

Property Name	Type	Description
name	string	the name of this model
admin	boolean	Whether the model is admin

Response Payload

Property Name	Type	Description
id	string	the id of the server
name	string	the name of this model
admin	boolean	Whether the model is admin

Sample request

curl 'https://apis.example.com/v1/example' \
-H 'Content-Type: application/json' \
-H 'Authorization: ${TOKEN}' \
-d \
'{
    "name": "test",
    "admin": true
}'

In the example above, you would replace ${TOKEN} with the generated Auth token, Refer: User Authorization .

A successful request is indicated by a 200 OK HTTP status code. The response contains id of your model

Sample response

{
  "id": "A163D1C8AA1FD43CAF521B74FC5A46BE",
  "name": "test",
  "admin": "true",
  "expiresIn": "3600"
}

Common error codes

invalid_argument: the [name] may be tool long for database
permission_denied: you may have no permission for this operation

Other errors you may need to refer to the global error code.

Markdown

picture: image/dropbox_geoblast.jpg tags: [Markdown, 模板] date: 2019-03-05

分享幾個常用的 Markdown 模板

頭腦風暴

💡頭腦風暴： 添加主題

靈感

想法

後續步驟

會議記錄

🕘 會議記錄： 添加事件名稱

2019-03-02

與會者

議程

討論

操作項目

項目計劃

📋 項目計劃： 添加項目

時間線

詳細信息

待辦事項

RestAPI文檔

英文文檔源碼

💡頭腦風暴：添加主題

🕘 會議記錄：添加事件名稱

📋 項目計劃：添加項目