Skip to content

English

Sofi edited this page Oct 2, 2019 · 4 revisions

Style Guide

All Developer Site content uses flavored Markdown syntax, with some customizations. Next, you'll find examples for the main features.

Headings

Use # for the main heading.
Use two ## for subheadings.
Add more ##### for smaller subtitles.

An example:
# This is a title
## This is a subtitle
#### These are smaller subtitles

Output

This is a title

This is a subtitle

These are smaller subtitles

Notes

Use > sign to write notes apart from the main text.

> This is an example.

It'll look like this:

This is an example.

NOTE tag

You can add a NOTE tag to your note and it will appear with custom styles.

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

This will be the output:
Note tag

WARNING Tag

You can also have a note with a Warning tag:

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

Output:
Warning tag

Ordered list

By writing

1. Option 1
1. Option 2
1. Option 3
  1. Option 3ª

you will get:

  1. Option 1
  2. Option 2
  3. Option 3
    1. Option 3ª

Unordered list

Write:

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

and you'll obtain:

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

Bold and italics

You have different options for creating bold and italic text.

*This text will be italic*
_This will also be italic_
*This text will be bold*
_This will also be bold_
_You can combine them_

Output:

This text will be italic
This will also be italic
This text will be bold
This will also be bold
You can combine them

Inline code

Enclose text between two ` in order to highlight some key concepts.

`It will look like this`

Output:

It will look like this

Code Snippets

You can show code snippets in a block format with its specific language highlight. The first line of the block should be 3 ` followed by the name of the language and the last line should be three ` alone.

Example:

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

Output:

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

Snippets with different languages

Show various snippets in different languages by displaying each one in different tabs of the same component.

[[[
```language 1
Snippet 1
```
```language 2
Snippet 2
```
]]]

Output
Component wit various languages

Comments in code snippets

Use this format to add comments.

[[[
```swift
===
Insert comment here
===
Snippet
```
]]]

Output
Swift

Credentials

Include following constants in the place where you want to add the credentials. If you're logged in, they would be automatically replaced.

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

Fake data

Include these constants wherever you want to assign different values to different countries.

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

See next format to add links.

[Here](https://developers.mercadopago.com/) you can see Mercado Pago Developer Site.

Output:

Here you can see Mercado Pago Developer Site.

Tables

Copy this format to create tables:

First column | Second column
----------------- | -----------------
Row 1 columm 1 | Row 1 column 2
Row 2 column 1 | Row 2 column 2

Output:

First column Second column
Row 1 column 1 Row 1 column 2
Row 2 column 1 Row 2 column 2

Images

Add your images in this folder: /images/nombredelproducto. For alt text, use this formula: Image description + product + Mercado Pago.

Example:

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

Output:
Button Web Checkout Mercado Pago

Checklist

- [x] This is done
- [ ] This is not done.

Output:

  • This is done
  • This is not done.

Articles by country

Make entire articles available in specified countries by following this next template. If it's indexed, it won't show up on the menu.

---
sites_supported:
- mla
- mlb
- mpe
---
Documentation

Output
Articles by country

Sections by country

Make fragments of articles available to specific countries with this template.

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

Output:
Sections by country