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

Partilhar alguns modelos de Markdown comuns

Markdown já substituiu basicamente outras ferramentas de texto no nosso uso diário, mas ao contrário de outros editores de texto, não há muitos modelos para novos projetos. Há uns dias, vi no Dropbox Paper alguns modelos de Markdown bem-feitos. Organizei-os e anexei alguns modelos comuns de Markdown para partilhar.

Os modelos incluem:

Brainstorming
Notas de Reunião
Plano de Projeto
Documentação RestAPI

Por fim, anexo o código-fonte do documento em inglês

Código-fonte do documento em inglês

Brainstorming

Código-fonte

# 💡 Brainstorming: Adicionar um tema

| **Objetivo**  | Que tipo de ideias quer?              |
| ------- | ----------------------- |
| **Participantes** | @mencionar você mesmo e outras pessoas              |
| **Relacionado**  | - 🔗 [Inserir alguns documentos ou links]() |

## Inspiração

Utilize a barra de ferramentas que aparece quando clica em "return" para adicionar imagens, vídeos, etc.


## Ideias

Faça uma pergunta ao grupo para dar início às coisas

----------
## Próximos passos

- [ ] Pensar fora da caixa @alguém
- [ ] De pendente a concluído @alguém

Efeito de exibição (com indentação ajustada)

💡 Brainstorming: Adicionar um tema

Objetivo	Que tipo de ideias quer?
Participantes	@mencionar você mesmo e outras pessoas
Relacionado	-Documento relacionado 1 `<br>`- Inserir documento relacionado

Inspiração

Utilize a barra de ferramentas que aparece quando clica em "return" para adicionar imagens, vídeos, etc.

Ideias

Faça uma pergunta ao grupo para dar início às coisas

Próximos passos

[ ] Pensar fora da caixa @alguém
[ ] De pendente a concluído @alguém

Notas de Reunião

Código-fonte

# 🕘 Notas de Reunião: Adicionar nome do evento

# 2019-03-02

****
## Participantes

@mencionar você mesmo e adicionar outras pessoas


## Agenda
- Agenda da reunião


## Discussão
- O que realmente discutimos


## Itens de ação

- [ ] Vamos concluir esta tarefa @alguém

Efeito de exibição (com indentação ajustada)

🕘 Notas de Reunião: Adicionar nome do evento

2019-03-02

Participantes

@mencionar você mesmo e adicionar outras pessoas

Agenda

Agenda da reunião

Discussão

O que realmente discutimos

Itens de ação

[ ] Vamos concluir esta tarefa @alguém

Plano de Projeto

# 📋 Plano de Projeto: Adicionar projeto

| **Descrição** | O que tem em mente?                 |
| ------ | ----------------------- |
| **Estado** | Antecipado 🌱 | Em progresso 🔨 | Concluído ⭐  |
| **Equipa** | Função: @alguém<br>Função: @alguém      |
| **Relacionado** | - [Documento relacionado 1](document1) <br>- [Inserir documento relacionado](http://document) |

## Linha do tempo

| Título | Data (Prazo) | Atribuído a | Descrição |
| --- | :---------: | ------- | --- |
|     | 03.01-03.12 |         |     |

## Detalhes

Utilize a barra de ferramentas que aparece quando clica em "return" para adicionar imagens, vídeos, etc.


## Tarefas a fazer

- [ ] Vamos concluir esta tarefa @alguém
- [ ] Vamos resolver esta tarefa hoje @alguém

Efeito de exibição (com indentação ajustada)

📋 Plano de Projeto: Adicionar projeto

Descrição	O que tem em mente?
Estado	Antecipado 🌱
Equipa	Função: @alguém`<br>`Função: @alguém
Relacionado	-Documento relacionado 1 `<br>`- Inserir documento relacionado

Linha do tempo

Título	Data	Atribuído a	Descrição
	03.01-03.12

Detalhes

Utilize a barra de ferramentas que aparece quando clica em "return" para adicionar imagens, vídeos, etc.

Tarefas a fazer

[ ] Vamos concluir esta tarefa @alguém
[ ] Vamos resolver esta tarefa hoje @alguém

Documentação RestAPI

### O título da sua API REST

Alguma descrição da sua API

**Método:** POST

**Content-Type:** application/json

**Endpoint**

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

Request Body Payload

Nome da Propriedade	Tipo	Descrição
name	string	o nome deste modelo
admin	boolean	Se o modelo é admin

Response Payload

Nome da Propriedade	Tipo	Descrição
id	string	o id do servidor
name	string	o nome deste modelo
admin	boolean	Se o modelo é admin

Exemplo de pedido

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

No exemplo acima, substitua ${TOKEN} pelo token de autenticação gerado. Consulte: Autorização de Usuário.

Um pedido bem-sucedido é indicado por um código de status HTTP 200 OK. A resposta contém o id do seu modelo

Exemplo de resposta

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

Códigos de erro comuns

invalid_argument: o [name] pode ser muito longo para o banco de dados
permission_denied: pode não ter permissão para esta operação

Outros erros que pode precisar consultar no código de erro global.


**Efeito de exibição** (com indentação ajustada)

### O título da sua API REST

Alguma descrição da sua API

**Método:** POST

**Content-Type:** application/json

**Endpoint**

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

Request Body Payload

Nome da Propriedade	Tipo	Descrição
name	string	o nome deste modelo
admin	boolean	Se o modelo é admin

Response Payload

Nome da Propriedade	Tipo	Descrição
id	string	o id do servidor
name	string	o nome deste modelo
admin	boolean	Se o modelo é admin

Exemplo de pedido

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

No exemplo acima, substitua ${TOKEN} pelo token de autenticação gerado. Consulte: Autorização de Usuário.

Um pedido bem-sucedido é indicado por um código de status HTTP 200 OK. A resposta contém o id do seu modelo

Exemplo de resposta

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

Códigos de erro comuns

invalid_argument: o [name] pode ser muito longo para o banco de dados
permission_denied: pode não ter permissão para esta operação

Outros erros que pode precisar consultar no código de erro global.

Código-fonte do documento em inglês

Brainstorming

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

Plano de Projeto

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

Notas de Reunião*

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

Modelos de API REST

### 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, 模pla] date: 2019-03-05

Partilhar alguns modelos de Markdown comuns

Brainstorming

💡 Brainstorming: Adicionar um tema

Inspiração

Ideias

Próximos passos

Notas de Reunião

🕘 Notas de Reunião: Adicionar nome do evento

2019-03-02

Participantes

Agenda

Discussão

Itens de ação

Plano de Projeto

📋 Plano de Projeto: Adicionar projeto

Linha do tempo

Detalhes

Tarefas a fazer

Documentação RestAPI

Código-fonte do documento em inglês