Skip to content

Português

Lucas Kewin edited this page Oct 3, 2019 · 8 revisions

Guia de estilo

Todo o conteúdo do site do desenvolvedor usa uma sintaxe de Markdown, com alguns recursos personalizados. Abaixo, você pode ver exemplos dos conceitos básicos mais usados.

Títulos

Use um # para o título principal.
Use dois sinais ## para subtítulos.
Adicione mais ##### para subtítulos menores.

Por exemplo, ao escrever:
# Este é um título
## Este é um subtítulo
#### Este é um subtítulo menor

Ficará assim:

Este é um título.

Este é um subtítulo.

Este é um subtítulo menor.

Seções em destaque

Com o sinal > você pode escrever notas destacadas do texto principal.

> Esta é uma seção de exemplo.

Isso ficará assim:

Esta é uma seção de exemplo.

Seção com etiqueta Nota

Você pode adicionar uma etiqueta de NOTA com estilos padrão à seção da seguinte maneira:

> NOTE
>
> Nota
>
> Esta é uma chave pública ...

E o resultado terá a seguinte aparência:
imagen ejemplo de tag Nota

Seção com etiqueta WARNING

Você também pode colocar uma nota destacada em uma etiqueta de "Aviso", da seguinte maneira:

> WARNING
>
> Título
>
>Esta é uma chave pública...

O que será visto assim:

Lista numerada

Escrevendo:

1. Opção 1
1. Opção 2
1. Opção 3
  1. Opção 3ª

você verá o seguinte:

  1. Opção 1
  2. Opção 2
  3. Opção 3
    1. Opção 3ª

Lista com marcadores

Escrevendo:

- Opção 1
- Opção 2
- Opção 3
* Opção 4

você verá o seguinte:

  • Opção 1
  • Opção 2
  • Opção 3
  • Opção 4

Negrito e itálico

Existem várias opções:

*Isso ficará em itálico.*
_Isso também estará em itálico._
*Isso estará em negrito*
_Isso também estará em negrito_
_Você pode combinar ambos_

O resultado será semelhante a este:

Isso ficará em itálico.
Isso também estará em itálico.
Isso estará em negrito
Isso também estará em negrito
Você pode combinar ambos

Linha de código

Entre com uma frase entre os sinais ` para ressalta-la ou para alguma palavra chave para utilizar no código.

`Ficará assim`

Resultado:

Ficará assim

Bloco de código (Snippets)

Você pode mostrar um bloco de código com destaque na linguagem em que está escrito. Para conseguir isso, coloque no início do código uma linha contendo 3 vezes o sinal ` imediatamente seguido pelo nome da linguagem e, no final, outra linha contendo 3 vezes o sinal `.

Exemplo de snippet:

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

O exemplo anterior será mostrado como:

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

Bloco de código em várias linguagens

Da seguinte maneira, você pode exibir snippets de código de diferentes linguagens, separados em guias do mesmo componente.

[[[
```linguagem 1
Snippet 1
```
```linguagem 2
Snippet 2
```
]]]

Bloco de código com comentários

Adicione comentários da seguinte forma:

[[[
```swift
===
Insira um comentário aqui
===
Snippet
```
]]]

Credenciais

Inclua as seguintes constantes nas quais deseja adicionar as credenciais. Se o leitor estiver logado em sua conta, elas serão substituídos automaticamente.

ENV_CLIENT_ID
ENV_CLIENT_SECRET
ENV_PUBLIC_KEY (test)
ENV_ACCESS_TOKEN (test)
PROD_PUBLIC_KEY (produtivas)
PROD_ACCESS_TOKEN (produtivas)

Dados fictícios

Inclua as seguintes constantes onde deseja localizar o conteúdo de acordo com cada país.

Nome:[FAKER][NAME]
Endereço:[FAKER][ADDRESS][STREET_ADDRESS]
Moeda: [FAKER][CURRENCY][ACRONYM]
Produto: [FAKER][COMMERCE][PRODUCT_NAME]
País: [FAKER][GLOBALIZE][UPPER_SITE_ID]

Links

Use a seguinte sintaxe para adicionar links.

[Aqui](https://developers.mercadopago.com/) você pode ver o site do desenvolvedor do Mercado Pago.

Resultado:

Aqui você pode ver o site do desenvolvedor do Mercado Pago.

Tabelas

As tabelas são criadas da seguinte maneira:

Primeira coluna| Segunda coluna
----------------- | -----------------
Linha 1 coluna 1 | Linha 1 coluna 2
Linha 2 coluna 1 | Linha 2 coluna 2

Resultado:

Primeira coluna| Segunda coluna
----------------- | -----------------
Linha 1 coluna 1 | Linha 1 coluna 2
Linha 2 coluna 1 | Linha 2 coluna 2

Imagens

Adicione suas imagens na pasta / images / product name. Adicione um texto alternativo seguindo este esquema: Descrição da imagem + produto + Mercado Pago. Por exemplo:

Pagamento com dois cartões Smart Checkout Mercado Pago

Caixa de seleção

Você pode criar listas de tarefas e marcar as concluídas.

- [x] Esta é uma tarefa feita.
- [] Esta não é uma tarefa concluída.

Resultado:

  • Esta é uma tarefa feita.
  • [] Esta não é uma tarefa concluída.

Artigos por país

Você pode disponibilizar artigos completos por país, copiando o seguinte formato. No caso de ser indexado, não será mostrado no menu.

---
sites_supported:
- mla
- mlb
- mpe
---
Documentação

Seções por país

Fragmentos disponíveis de artigos por país, usando o seguinte modelo.

----[mla, mpe]----
Este conteúdo está disponível apenas para Peru e Argentina.
------------
----[mlb]----
Este conteúdo está disponível apenas no Brasil.
------------