picture: image/dropbox_geoblast.jpg tags: [Markdown, 템플릿] date: 2019-03-05

자주 사용하는 Markdown 템플릿 공유

Markdown은 일상적인 사용에서 기본적으로 다른 텍스트 도구를 대체하고 있습니다. 하지만 다른 텍스트 편집기와 달리 새로운 프로젝트 템플릿이 많지 않습니다. 며칠 전 Dropbox Paper에서 몇 가지 Markdown 템플릿을 보았습니다.

몇 가지 Markdown 템플릿이 잘 만들어져 있어, 이를 정리하고 자주 사용하는 몇 가지 Markdown 분류를 공유합니다.

템플릿 포함:

브레인스토밍
회의 기록
프로젝트 계획
RestAPI 문서

마지막으로, 영어 문서 소스 코드 첨부

영어 문서 소스 코드

브레인스토밍

소스 코드

# 💡 브레인스토밍: 주제 추가

| **목표**  | 어떤 종류의 아이디어가 필요하신가요?          |
| ------- | ----------------------- |
| **참여자** | @자신과 다른 사람을 언급하세요          |
| **관련**  | - 🔗 [문서나 링크 삽입]() |

## 영감

'Enter'를 눌러 표시되는 도구 모음을 사용하여 이미지, 비디오 등을 추가하세요


## 아이디어

팀에 질문을 던져서 논의를 시작하세요

----------
## 다음 단계

- [ ] 고정관념을 깨기 @누군가
- [ ] 할 일에서 완료로 @누군가

표시 효과 (들여쓰기 조정됨)

💡 브레인스토밍: 주제 추가

목표	어떤 종류의 아이디어가 필요하신가요?
참여자	@자신과 다른 사람을 언급하세요
관련	-관련 문서1 `<br>`- 관련 문서 삽입

영감

'Enter'를 눌러 표시되는 도구 모음을 사용하여 이미지, 비디오 등을 추가하세요

아이디어

팀에 질문을 던져서 논의를 시작하세요

다음 단계

[ ] 고정관념을 깨기 @누군가
[ ] 할 일에서 완료로 @누군가

회의 기록

소스 코드

# 🕘 회의 기록: 이벤트 이름 추가

# 2019-03-02

****
## 참석자

@자신과 다른 사람을 추가하세요


## 의제
- 회의 의제


## 토론
- 실제로 논의한 내용


## 실행 항목

- [ ] 이 작업을 완료합시다 @누군가

표시 효과 (들여쓰기 조정됨)

🕘 회의 기록: 이벤트 이름 추가

2019-03-02

참석자

@자신과 다른 사람을 추가하세요

의제

회의 의제

토론

실제로 논의한 내용

실행 항목

[ ] 이 작업을 완료합시다 @누군가

프로젝트 계획

# 📋 프로젝트 계획: 프로젝트 추가

| **설명** | 어떤 아이디어가 있나요?                 |
| ------ | ----------------------- |
| **상태** | 초기 🌱 | 진행 중 🔨 | 완료 ⭐  |
| **팀** | 역할: @누군가<br>역할: @누군가      |
| **관련** | - [관련 문서1](document1) <br>- [관련 문서 삽입](http://document) |

## 타임라인

| 제목 | 날짜(마감일) | 담당자 | 설명 |
| --- | :---------: | ------- | --- |
|     | 03.01-03.12 |         |     |

## 세부 정보

'Enter'를 눌러 표시되는 도구 모음을 사용하여 이미지, 비디오 등을 추가하세요


## 할 일

- [ ] 이 작업을 완료하겠습니다 @누군가
- [ ] 오늘 이 작업을 해결합시다 @누군가

표시 효과 (들여쓰기 조정됨)

📋 프로젝트 계획: 프로젝트 추가

설명	어떤 아이디어가 있나요?
상태	초기 🌱
팀	역할: @누군가`<br>`역할: @누군가
관련	-관련 문서1 `<br>`- 관련 문서 삽입

타임라인

제목	날짜	담당자	설명
	03.01-03.12

세부 정보

'Enter'를 눌러 표시되는 도구 모음을 사용하여 이미지, 비디오 등을 추가하세요

할 일

[ ] 이 작업을 완료하겠습니다 @누군가
[ ] 오늘 이 작업을 해결합시다 @누군가

RestAPI 문서

### REST API 제목

API에 대한 설명

**Method:** POST

**Content-Type:** application/json

**Endpoint**

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

Request Body Payload

속성 이름	유형	설명
name	string	이 모델의 이름
admin	boolean	이 모델이 관리자 여부

Response Payload

속성 이름	유형	설명
id	string	서버의 ID
name	string	이 모델의 이름
admin	boolean	이 모델이 관리자 여부

예시 요청

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

위 예시에서 ${TOKEN}을 생성된 인증 토큰으로 교체하세요. 참고: 사용자 인증.

성공적인 요청은 200 OK HTTP 상태 코드로 표시됩니다. 응답에는 모델의 ID가 포함됩니다.

예시 응답

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

일반 오류 코드

invalid_argument: [name]이 데이터베이스에 너무 길 수 있음
permission_denied: 이 작업에 대한 권한이 없을 수 있음

다른 오류는 전역 오류 코드를 참조하세요.


**표시 효과** (들여쓰기 조정됨)

### REST API 제목

API에 대한 설명

**Method:** POST

**Content-Type:** application/json

**Endpoint**

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

Request Body Payload

속성 이름	유형	설명
name	string	이 모델의 이름
admin	boolean	이 모델이 관리자 여부

Response Payload

속성 이름	유형	설명
id	string	서버의 ID
name	string	이 모델의 이름
admin	boolean	이 모델이 관리자 여부

예시 요청

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

위 예시에서 ${TOKEN}을 생성된 인증 토큰으로 교체하세요. 참고: 사용자 인증.

성공적인 요청은 200 OK HTTP 상태 코드로 표시됩니다. 응답에는 모델의 ID가 포함됩니다.

예시 응답

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

일반 오류 코드

invalid_argument: [name]이 데이터베이스에 너무 길 수 있음
permission_denied: 이 작업에 대한 권한이 없을 수 있음

다른 오류는 전역 오류 코드를 참조하세요.

영어 문서 소스 코드

브레인스토밍

# 💡 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: 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: 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 템플릿

### 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.

마크다운

picture: image/dropbox_geoblast.jpg tags: [Markdown, 템플릿] date: 2019-03-05

자주 사용하는 Markdown 템플릿 공유

브레인스토밍

💡 브레인스토밍: 주제 추가

영감

아이디어

다음 단계

회의 기록

🕘 회의 기록: 이벤트 이름 추가

2019-03-02

참석자

의제

토론

실행 항목

프로젝트 계획

📋 프로젝트 계획: 프로젝트 추가

타임라인

세부 정보

할 일

RestAPI 문서

영어 문서 소스 코드