picture: image/dropbox_geoblast.jpg tags: [Markdown, шаблон] date: 2019-03-05

Поделюсь несколькими часто используемыми шаблонами Markdown

Markdown в нашей повседневной практике практически заменил другие текстовые инструменты, но в отличие от других текстовых редакторов, здесь не так много шаблонов для новых проектов. Недавно я увидел на Dropbox Paper несколько шаблонов Markdown, которые были сделаны очень хорошо. Я их собрал и добавил несколько часто используемых шаблонов Markdown для разделения.

Шаблоны включают:

Мозговой штурм
Протоколы собраний
План проекта
Документация RestAPI

В конце прикрепляю исходный код документа на английском языке

Исходный код документа на английском языке

Мозговой штурм

Исходный код

# 💡Мозговой штурм: Добавьте тему

| **Цель**        | Какие идеи вы хотите получить?            |
| --------------- | ----------------------------------------- |
| **Участники**   | @упомяните себя и других                  |
| **Связанные**   | - 🔗 [Вставьте некоторые документы или ссылки]() |

## Вдохновение

Используйте панель инструментов, которая появляется при нажатии "Возврат", чтобы добавлять изображения, видео и другое

## Идеи

Задайте команде вопрос, чтобы начать обсуждение

----------
## Следующие шаги

- [ ] Выйти за рамки @кто-то
- [ ] От "сделать" до "сделано" @кто-то

Отображение (с поправкой на отступы)

💡Мозговой штурм: Добавьте тему

Цель	Какие идеи вы хотите получить?
Участники	@упомяните себя и других
Связанные	-Связанный документ1 `<br>`- Вставьте связанный документ

Вдохновение

Используйте панель инструментов, которая появляется при нажатии "Возврат", чтобы добавлять изображения, видео и другое

Идеи

Задайте команде вопрос, чтобы начать обсуждение

Следующие шаги

[ ] Выйти за рамки @кто-то
[ ] От "сделать" до "сделано" @кто-то

Протоколы собраний

Исходный код

# 🕘 Протоколы собраний: Добавьте название события

# 2019-03-02

****
## Участники

@упомяните себя и добавьте других


## Повестка дня
- Повестка дня собрания


## Обсуждение
- Что мы действительно обсуждали


## Действия

- [ ] Мы выполним эту задачу @кто-то

Отображение (с поправкой на отступы)

🕘 Протоколы собраний: Добавьте название события

2019-03-02

Участники

@упомяните себя и добавьте других

Повестка дня

Повестка дня собрания

Обсуждение

Что мы действительно обсуждали

Действия

[ ] Мы выполним эту задачу @кто-то

План проекта

# 📋 План проекта: Добавьте проект

| **Описание** | Какие у вас идеи?                   |
| ------------ | ----------------------------------- |
| **Статус**   | Ранний 🌱 | В процессе 🔨 | Завершено ⭐ |
| **Команда**  | Роль: @кто-то<br>Роль: @кто-то      |
| **Связанные**| - [Связанный документ1](document1) <br>- [Вставьте связанный документ](http://document) |

## Таймлайн

| Заголовок | Дата (Срок) | Назначено | Описание |
| --------- | :---------: | --------- | -------- |
|           | 03.01-03.12 |           |          |

## Подробности

Используйте панель инструментов, которая появляется при нажатии "Возврат", чтобы добавлять изображения, видео и другое


## Список дел

- [ ] Мы выполним эту задачу @кто-то
- [ ] Мы решим эту задачу сегодня @кто-то

Отображение (с поправкой на отступы)

📋 План проекта: Добавьте проект

Описание	Какие у вас идеи?
Статус	Ранний 🌱
Команда	Роль: @кто-то`<br>`Роль: @кто-то
Связанные	-Связанный документ1 `<br>`- Вставьте связанный документ

Таймлайн

Заголовок	Дата	Назначено	Описание
	03.01-03.12

Подробности

Список дел

[ ] Мы выполним эту задачу @кто-то
[ ] Мы решим эту задачу сегодня @кто-то

Документация RestAPI

### Заголовок вашего Rest API

Некоторое описание вашего API

**Метод:** POST

**Content-Type:** application/json

**Endpoint**

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

Request Body Payload

Название свойства	Тип	Описание
name	string	имя этой модели
admin	boolean	Является ли модель администратором

Response Payload

Название свойства	Тип	Описание
id	string	идентификатор сервера
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} на сгенерированный токен авторизации. См. Авторизация пользователя.

Успешный запрос обозначается кодом состояния HTTP 200 OK. Ответ содержит идентификатор вашей модели.

Пример ответа

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

Общие коды ошибок

invalid_argument: [name] может быть слишком длинным для базы данных
permission_denied: у вас может не быть разрешения на эту операцию

Другие ошибки вы можете найти в глобальном коде ошибок.


**Отображение** (с поправкой на отступы)

### Заголовок вашего Rest API

Некоторое описание вашего API

**Метод:** POST

**Content-Type:** application/json

**Endpoint**

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

Request Body Payload

Название свойства	Тип	Описание
name	string	имя этой модели
admin	boolean	Является ли модель администратором

Response Payload

Название свойства	Тип	Описание
id	string	идентификатор сервера
name	string	имя этой модели
admin	boolean	Является ли модель администратором

Пример запроса

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

Успешный запрос обозначается кодом состояния HTTP 200 OK. Ответ содержит идентификатор вашей модели.

Пример ответа

{
  "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.

разметка Markdown

picture: image/dropbox_geoblast.jpg tags: [Markdown, шаблон] date: 2019-03-05

Поделюсь несколькими часто используемыми шаблонами Markdown

Мозговой штурм

💡Мозговой штурм: Добавьте тему

Вдохновение

Идеи

Следующие шаги

Протоколы собраний

🕘 Протоколы собраний: Добавьте название события

2019-03-02

Участники

Повестка дня

Обсуждение

Действия

План проекта

📋 План проекта: Добавьте проект

Таймлайн

Подробности

Список дел

Документация RestAPI

Исходный код документа на английском языке