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) |

## タイムライン

| タイトル | 日付(締切) | 担当者 | 説明 |
| --- | :---------: | ------- | --- |
|     | 03.01-03.12 |         |     |

## 詳細

「戻る」を押すと表示されるツールバーを使って画像や動画を追加します


## やるべきこと

- [ ] このタスクを完了しましょう @誰か
- [ ] 今日このタスクに取り組みましょう @誰か

表示効果 (インデントを調整済み)

📋 プロジェクト計画：プロジェクトを追加

説明	どんな考えがありますか？
状態	早期 🌱
チーム	役割: @誰か`<br>`役割: @誰か
関連	-関連ドキュメント１ `<br>`- 関連ドキュメントを挿入

タイムライン

タイトル	日付	担当者	説明
	03.01-03.12

詳細

「戻る」を押すと表示されるツールバーを使って画像や動画を追加します

やるべきこと

[ ] このタスクを完了しましょう @誰か
[ ] 今日このタスクに取り組みましょう @誰か

RestAPI文書

### あなたのREST APIのタイトル

APIの説明

**メソッド:** POST

**Content-Type:** application/json

**エンドポイント**

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

リクエストボディペイロード

プロパティ名	型	説明
name	string	このモデルの名前
admin	boolean	モデルが管理者かどうか

レスポンスペイロード

プロパティ名	型	説明
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の説明

**メソッド:** POST

**Content-Type:** application/json

**エンドポイント**

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

リクエストボディペイロード

プロパティ名	型	説明
name	string	このモデルの名前
admin	boolean	モデルが管理者かどうか

レスポンスペイロード

プロパティ名	型	説明
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

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

マークダウン

picture: image/dropbox_geoblast.jpg tags: [Markdown, テンプレート] date: 2019-03-05

よく使うMarkdownテンプレートの紹介

ブレインストーミング

💡ブレインストーミング： テーマを追加

インスピレーション

アイデア

次のステップ

会議記録

🕘 会議記録： イベント名を追加

2019-03-02

参加者

アジェンダ

議論

アクションアイテム

プロジェクト計画

📋 プロジェクト計画： プロジェクトを追加

タイムライン

詳細

やるべきこと

RestAPI文書

英語のドキュメントソース

💡ブレインストーミング：テーマを追加

🕘 会議記録：イベント名を追加

📋 プロジェクト計画：プロジェクトを追加