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

Compartir algunos plantillas comunes de Markdown

Markdown en nuestro uso diario de aplicaciones básicamente ya ha reemplazado a otras herramientas de texto. Sin embargo, a diferencia de otros editores de texto, no hay muchos plantillas para nuevos proyectos. Hace unos días vi en Dropbox Paper algunos plantillas de Markdown que están muy bien hechos. Los he organizado y he incluido algunos plantillas comunes de Markdown para compartir.

Los plantillas incluyen:

Tormenta de ideas
Notas de reunión
Plan de proyecto
Documentación RestAPI

Finalmente, se adjunta el código fuente del documento en inglés.

Código fuente del documento en inglés

Tormenta de ideas

Código fuente

# 💡 Tormenta de ideas: Añadir tema

| **Objetivo**  | ¿Qué tipo de ideas quieres?              |
| ------- | ----------------------- |
| **Participantes** | @menciona a ti mismo y a otros              |
| **Relacionado**  | - 🔗 [Inserta algunos documentos o enlaces]() |

## Inspiración

Usa la barra de herramientas que aparece cuando presionas "enter" para añadir imágenes, videos, etc.

## Ideas

Haz una pregunta al equipo para que las cosas fluyan

----------
## Próximos pasos

- [ ] Piensa fuera de la caja @alguien
- [ ] De pendiente a hecho @alguien

Efecto visual (con sangría ajustada)

💡 Tormenta de ideas: Añadir tema

Objetivo	¿Qué tipo de ideas quieres?
Participantes	@menciona a ti mismo y a otros
Relacionado	-Documento relacionado 1 `<br>`- Inserta documento relacionado

Inspiración

Usa la barra de herramientas que aparece cuando presionas "enter" para añadir imágenes, videos, etc.

Ideas

Haz una pregunta al equipo para que las cosas fluyan

Próximos pasos

[ ] Piensa fuera de la caja @alguien
[ ] De pendiente a hecho @alguien

Notas de reunión

Código fuente

# 🕘 Notas de reunión: Añadir nombre del evento

# 2019-03-02

****
## Asistentes

@menciona a ti mismo y añade a otros

## Agenda
- Agenda de la reunión

## Discusión
- Lo que realmente discutimos

## Acciones

- [ ] Vamos a completar esta tarea @alguien

Efecto visual (con sangría ajustada)

🕘 Notas de reunión: Añadir nombre del evento

2019-03-02

Asistentes

@menciona a ti mismo y añade a otros

Agenda

Agenda de la reunión

Discusión

Lo que realmente discutimos

Acciones

[ ] Vamos a completar esta tarea @alguien

Plan de proyecto

# 📋 Plan de proyecto: Añadir proyecto

| **Descripción** | ¿Qué tienes en mente?                 |
| ------ | ----------------------- |
| **Estado** | Temprano 🌱 | En progreso 🔨 | Completado ⭐  |
| **Equipo** | Rol: @alguien<br>Rol: @alguien      |
| **Relacionado** | - [Documento relacionado 1](document1) <br>- [Inserta documento relacionado](http://document) |

## Línea de tiempo

| Título | Fecha (Plazo) | Asignado a | Descripción |
| --- | :---------: | ------- | --- |
|     | 03.01-03.12 |         |     |

## Detalles

Usa la barra de herramientas que aparece cuando presionas "enter" para añadir imágenes, videos, etc.

## Tareas pendientes

- [ ] Vamos a completar esta tarea @alguien
- [ ] Vamos a resolver esta tarea hoy @alguien

Efecto visual (con sangría ajustada)

📋 Plan de proyecto: Añadir proyecto

Descripción	¿Qué tienes en mente?
Estado	Temprano 🌱
Equipo	Rol: @alguien`<br>`Rol: @alguien
Relacionado	-Documento relacionado 1 `<br>`- Inserta documento relacionado

Línea de tiempo

Título	Fecha	Asignado a	Descripción
	03.01-03.12

Detalles

Usa la barra de herramientas que aparece cuando presionas "enter" para añadir imágenes, videos, etc.

Tareas pendientes

[ ] Vamos a completar esta tarea @alguien
[ ] Vamos a resolver esta tarea hoy @alguien

Documentación RestAPI

### El título de tu rest api

Alguna descripción de tu api

**Método:** POST

**Content-Type:** application/json

**Endpoint**

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

Carga útil del cuerpo de la solicitud

Nombre de la propiedad	Tipo	Descripción
name	string	el nombre de este modelo
admin	boolean	Si el modelo es admin

Carga útil de la respuesta

Nombre de la propiedad	Tipo	Descripción
id	string	el id del servidor
name	string	el nombre de este modelo
admin	boolean	Si el modelo es admin

Solicitud de ejemplo

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

En el ejemplo anterior, reemplazarías ${TOKEN} con el token de autenticación generado. Consulta: Autorización de usuario.

Una solicitud exitosa se indica con un código de estado HTTP 200 OK. La respuesta contiene el id de tu modelo.

Respuesta de ejemplo

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

Códigos de error comunes

invalid_argument: el [nombre] puede ser demasiado largo para la base de datos
permission_denied: es posible que no tengas permiso para esta operación

Otros errores pueden requerir que consultes el código de error global.


**Efecto visual** (con sangría ajustada)

### El título de tu rest api

Alguna descripción de tu api

**Método:** POST

**Content-Type:** application/json

**Endpoint**

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

Carga útil del cuerpo de la solicitud

Nombre de la propiedad	Tipo	Descripción
name	string	el nombre de este modelo
admin	boolean	Si el modelo es admin

Carga útil de la respuesta

Nombre de la propiedad	Tipo	Descripción
id	string	el id del servidor
name	string	el nombre de este modelo
admin	boolean	Si el modelo es admin

Solicitud de ejemplo

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

En el ejemplo anterior, reemplazarías ${TOKEN} con el token de autenticación generado. Consulta: Autorización de usuario.

Una solicitud exitosa se indica con un código de estado HTTP 200 OK. La respuesta contiene el id de tu modelo.

Respuesta de ejemplo

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

Códigos de error comunes

invalid_argument: el [nombre] puede ser demasiado largo para la base de datos
permission_denied: es posible que no tengas permiso para esta operación

Otros errores pueden requerir que consultes el código de error global.

Código fuente del documento en inglés

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

Compartir algunos plantillas comunes de Markdown

Tormenta de ideas

💡 Tormenta de ideas: Añadir tema

Inspiración

Ideas

Próximos pasos

Notas de reunión

🕘 Notas de reunión: Añadir nombre del evento

2019-03-02

Asistentes

Agenda

Discusión

Acciones

Plan de proyecto

📋 Plan de proyecto: Añadir proyecto

Línea de tiempo

Detalles

Tareas pendientes

Documentación RestAPI

Código fuente del documento en inglés

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