Skip to content

Español

Sofi edited this page Oct 2, 2019 · 10 revisions

Guía de estilo

Todo el contenido de nuestro developer site utiliza sintaxis de markdown enriquecido, con algunas características personalizadas. A continuación, podrás leer ejemplos de los conceptos básicos más utilizados.

Encabezados

Utiliza un # para el título principal.
Utiliza dos signos ## para los subtitulos.
Agrega más ##### para subtítulos más pequeños.

Por ejemplo, al escribir:
# Esto es un título
## Esto es un subtítulo
#### Estos son subtítulos pequeños

Se verá así:

Esto es un titulo

Esto es un subtitulo

Estos son subtítulos pequeños

Apartados destacados

Con el signo > podrás escribir notas destacadas del texto principal.

> Esto es un ejemplo de apartado.

Que se verá así:

Esto es un ejemplo de apartado.

Apartado con etiqueta Nota

Puedes agregar al apartado una etiqueta de NOTA con estilos predeterminados de la siguiente manera:

> NOTE
>
> Nota
>
> Esta es una clave pública...

Y el resultado se verá de la siguiente manera:
Cómo se ve Nota

Apartado con etiqueta Cuidado

También puedes colocar a tu nota destacada una etiqueta de "Cuidado", de la siguiente manera:

> WARNING
>
> Título
>
> Esta es una clave pública...

Que se verá de esta forma:
Cómo se ve Warning

Lista numerada

Escribiendo

1. Opción 1
1. Opción 2
1. Opción 3
  1. Opción 3ª

verás lo siguiente:

  1. Opción 1
  2. Opción 2
  3. Opción 3
    1. Opción 3ª

Lista con viñetas

Escribe:

- Opción 1
- Opción 2
- Opción 3
* Opción 4

Para obtener:

  • Opción 1
  • Opción 2
  • Opción 3
  • Opción 4

Negritas y cursivas

Existen varias opciones para lograrlo.

*Esto estará en cursiva*
_Esto también estará en cursiva_
*Esto estará en negritas*
_Esto también estará en negritas_
_Puedes combinar ambos_

El resultado se verá así:

Esto estará en cursiva
Esto también estará en cursiva
Esto estará en negritas
Esto también estará en negritas
Puedes combinar ambos

Código en línea

Encierra una frase entre dos signos ` para resaltarla o para alguna palabra clave a utilizar en el código.

`Se verá así`

Resultado:

Se verá así

Código en bloque (Snippets)

Puedes mostrar un bloque de código con highlight propio del lenguaje en el que está escrito. Para lograrlo, coloca al principio del código una línea que contenga 3 veces el signo ` seguido inmediatamente del nombre del lenguaje y, al final, otra línea que contenga 3 veces el signo `.

Ejemplo de snippet:

```javascript
function fancyAlert(arg) {
if(arg) {
$.facebox({div:'#foo'})
}
}
```

El anterior ejemplo se verá así:

function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}

Código en bloque en varios lenguajes

De la siguiente manera, puedes mostrar snippets de código de diferentes lenguajes, separados en pestañas de un mismo componente.

[[[
```lenguaje 1
Snippet 1
```
```lenguaje 2
Snippet 2
```
]]]

Resultado:
Cómo se ve Componente de varios lenguajes

Código en bloque con comentarios

Suma comentarios de la siguiente manera

[[[
```swift
===
Inserta un comentario aquí
===
Snippet
```
]]]

Resultado:
Swift

Credenciales

Incluye las siguientes constantes donde quieras sumar las credenciales. Si el lector ingresa con su cuenta, se reemplazan automáticamente.

ENV_CLIENT_ID
ENV_CLIENT_SECRET
ENV_PUBLIC_KEY (test)
ENV_ACCESS_TOKEN (test)
PROD_ACCESS_TOKEN (productivas)

Datos Ficticios

Incluye las siguientes constantes donde quieras localizar contenido según cada país.

Nombre:[FAKER][NAME]
Dirección:[FAKER][ADDRESS][STREET_ADDRESS]
Moneda: [FAKER][CURRENCY][ACRONYM]
Producto: [FAKER][COMMERCE][PRODUCT_NAME]
País: [FAKER][GLOBALIZE][UPPER_SITE_ID]

Links

Utiliza la siguiente sintaxis para sumar links.

[Aquí](https://developers.mercadopago.com/) puedes ver el sitio de desarrolladores de Mercado Pago.

Resultado:

Aquí puedes ver el sitio de desarrolladores de Mercado Pago.

Tablas

Las tablas se crean de la siguiente manera:

Primera columna | Segunda columna
----------------- | -----------------
Fila 1 columna 1 | Fila 1 columna 2
Fila 2 columna 1 | Fila 2 columna 2

Resultado:

Primera columna Segunda columna
Fila 1 columna 1 Fila 1 columna 2
Fila 2 columna 1 Fila 2 columna 2

Imágenes

Agrega tus imágenes en la carpeta /images/nombredelproducto y un texto alternativo siguiendo este esquema: Descripción de la imagen + producto + Mercado Pago. Por ejemplo:

![Botón Continuar Web Checkout Mercado Pago](https://github.com/mercadopago/devsite-docs/blob/development/images/web-payment-checkout/dark_color_button.png)

Resultado:
Botón Continuar Web Checkout Mercado Pago

Casilla de verificación

Puedes crear listas de tareas y marcar las completadas.

- [x] Esto es una tarea realizada
- [ ] Esto no es una tarea realizada.

Resultado:

  • Esto es una tarea realizada
  • Esto no es una tarea realizada

Artículos por país

Disponibiliza artículos completos por país copiando el siguiente formato. En el caso de estar indexado no se mostrará en el menú.

---
sites_supported:
- mla
- mlb
- mpe
---
Documentación

Resultado:
Artículos por país

Secciones por país

Disponibiliza fragmentos de artículos por país utilizando la siguiente plantilla.

----[mla, mpe]----
Este fragmento de contenido solo está disponible para Perú y Argentina.
------------
----[mlb]----
Este fragmento de contenido solo está disponible en Brasil.
------------

Resultado:
Secciones por país