---
title: "Contribuindo"
description: "Como contribuir com a documentação da Lacuna: abra uma issue para relatar erros ou lacunas e siga as orientações para novos artigos. Ainda sem pull requests."
canonical: "https://docs.lacunasoftware.com/articles/welcome/contributing"
locale: "pt-BR"
product: "Bem-vindo"
last_updated: "2026-10-12"
---

# Contribuindo

No momento, não estamos aceitando contribuições públicas, mas em breve passaremos a aceitar pull requests. Por enquanto,
se você encontrar um erro ou notar que falta algo neste portal de documentação,
[abra uma issue](https://github.com/LacunaSoftware/docs/issues)

## Criando um novo artigo

Siga estas orientações para criar um novo artigo:

1. Crie o artigo **nos dois projetos, en-us e pt-br**, com codificação UTF-8 com BOM
1. Altere o `toc.md` **dos dois projetos**, incluindo o artigo

> **Dica**
>
> Uma forma fácil de garantir que o novo artigo tenha codificação UTF-8 com BOM é copiar um artigo existente em vez de criar um arquivo novo.

Você não precisa escrever as duas versões do artigo de imediato: pode escrever uma das versões e colocar isto na outra:

```md
# Article title

{/* link to version in Portuguese */}
<div data-alt-locales="pt-br"></div>
```

ou

```md
# Título do Artigo

{/* link to version in English */}
<div data-alt-locales="en-us"></div>
```

## Escrevendo documentação

Estes são os links mais importantes sobre como escrever documentação:

* [Mastering Markdown - GitHub Guides](https://guides.github.com/features/mastering-markdown/)
* [DocFX Flavored Markdown - site do DocFX](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html)
* [Links and Cross References - site do DocFX](https://dotnet.github.io/docfx/tutorial/links_and_cross_references.html)
* [Overwrite Files - site do DocFX](https://dotnet.github.io/docfx/tutorial/intro_overwrite_files.html)

## Guia rápido de Markdown

Esta é a sintaxe dos elementos mais comuns:

* [Títulos](https://docs.lacunasoftware.com/articles/welcome/contributing#títulos)
* [Negrito](https://docs.lacunasoftware.com/articles/welcome/contributing#negrito)
* [Itálico](https://docs.lacunasoftware.com/articles/welcome/contributing#itálico)
* [Código inline](https://docs.lacunasoftware.com/articles/welcome/contributing#código-inline)
* [Listas](https://docs.lacunasoftware.com/articles/welcome/contributing#listas)
* [Linhas horizontais](https://docs.lacunasoftware.com/articles/welcome/contributing#linhas-horizontais)
* [Links](https://docs.lacunasoftware.com/articles/welcome/contributing#links)
* [Trechos de código](https://docs.lacunasoftware.com/articles/welcome/contributing#trechos-de-código)
* [Includes](https://docs.lacunasoftware.com/articles/welcome/contributing#includes)
* [Inclusão de trechos de código](https://docs.lacunasoftware.com/articles/welcome/contributing#inclusão-de-trechos-de-código)
* [Imagens](https://docs.lacunasoftware.com/articles/welcome/contributing#imagens)
* [Citações, notas e avisos](https://docs.lacunasoftware.com/articles/welcome/contributing#citações-notas-e-avisos)
* [Tabelas](https://docs.lacunasoftware.com/articles/welcome/contributing#tabelas)

### Títulos

Título de nível superior (H1):

```md
# Article title
```

Título de nível 2 (H2):

```md
## Section title
```

Título de nível 3 (H3):

```md
### Subsection title
```

### Negrito

```md
This is a **bold** statement
```

This is a **bold** statement

### Itálico

```md
This is a *foreign word*.
```

This is a *foreign word*.

### Código inline

```md
Pass the `callback` parameter
```

Pass the `callback` parameter

### Listas

Não ordenada:

```md
* Item A
* Item B
  * Subitem (prefix spaces to align with parent)
    * And so on
* Item C
```

* Item A
* Item B
  * Subitem (prefix spaces to align with parent)
    * And so on
* Item C

Ordenada:

```md
1. Item 1
1. Item 2
   1. Subitem (prefix spaces to align with parent)
      1. And so on
1. Item 3
```

1. Item 1
1. Item 2
   1. Subitem (prefix spaces to align with parent)
      1. And so on
1. Item 3

> A numeração em si não importa: o DocFX ordena a lista ao renderizar o arquivo. Prefira repetir `1.` em todos os itens em vez de escrever `1.`, `2.`, `3.` etc., porque isso facilita reordenar os itens.

### Linhas horizontais

Use `***` para inserir uma linha horizontal:

```md
Something

***

Some other thing
```

> **Observação**
>
> **Não** use a sintaxe `---`, pois ela tem um significado especial no DocFX

### Links

```md
[text](url)
```

Para artigos na mesma pasta:

```md
See the article [Welcome](index.md)
```

See the article [Welcome](https://docs.lacunasoftware.com/articles/welcome)

Para artigos em outras pastas:

```md
You can use the [Lacuna PKI SDK](../pki-sdk/index.md) for this purpose
```

You can use the [Lacuna PKI SDK](https://docs.lacunasoftware.com/articles/pki-sdk) for this purpose

Para classes:

```md
See class @Lacuna.RestPki.Client.RestPkiClient
```

See class @Lacuna.RestPki.Client.RestPkiClient

Para métodos:

```md
See method @Lacuna.RestPki.Client.RestPkiClient.GetPkiBrazilTimestamper
```

See method @Lacuna.RestPki.Client.RestPkiClient.GetPkiBrazilTimestamper

> Para descobrir os UIDs exatos de classes e métodos, veja os arquivos .yml da pasta `api` depois de compilar o projeto docfx.

Em alguns casos, a sintaxe `@uid` não funciona para referências cruzadas. Nesses casos, use:

```md
<xref:Lacuna.RestPki.Client.RestPkiClient>
```

Se o uid contiver um `#`, codifique-o como `%23`:

```md
<xref:Lacuna.Pki.LinkedTrustArbitrator.%23ctor(Lacuna.Pki.ITrustArbitrator[])>
```

Links para seções de artigos:

Primeiro, você precisa declarar o nome da âncora logo antes do título da seção:

```md
## Section title \{#anchor-name}
```

> **Observação**
>
> Se o artigo estiver em inglês e o título da seção corresponder ao nome da âncora (convertido para minúsculas e com os espaços substituídos por hifens), você
> não precisa declarar a âncora

Depois, para criar o link para a seção:

```md
See [Default error callback](../web-pki/advanced.md#default-error-callback)
```

See [Default error callback](https://docs.lacunasoftware.com/articles/web-pki/advanced#default-error-callback)

### Trechos de código

	```languageid
	code
	```

IDs de linguagem comuns:

* csharp ou cs
* javascript ou js
* html

Trechos de código podem ser indentados dentro de listas:

1. Instalação
   1. Prepare o ambiente
   1. Execute isto:

      ```bash
      sudo apt install something
      ```

   1. Finalize
1. Pronto

Veja todos os [nomes e aliases de linguagem](https://github.com/highlightjs/highlight.js#supported-languages) suportados.

### Includes

```md

{/* include: url */}

```

Blocos de include comuns aos dois idiomas ficam na pasta [includes/](https://github.com/LacunaSoftware/docs/tree/master/includes). Por exemplo, para
incluir o bloco [rest-pki-samples-matrix.md](https://github.com/LacunaSoftware/docs/blob/master/includes/rest-pki-samples-matrix.md) a partir de um local
como `docs.en-us/articles/project-name/article.md`:

```md

{/* include: ../../../includes/rest-pki-samples-matrix.md */}

```

Exemplo: [Rest PKI](https://docs.lacunasoftware.com/articles/rest-pki)

### Inclusão de trechos de código

* [Sintaxe](https://dotnet.github.io/docfx/spec/docfx_flavored_markdown.html#code-snippet)
* Exemplo: @Lacuna.Pki.Cades.CadesSignatureCompression \[[código-fonte](https://github.com/LacunaSoftware/docs/blob/master/docs.en-us/apidoc/Lacuna.Pki.Cades.CadesSignatureCompression.md)\]

### Imagens

```md
![Alt Text](url)
```

`url` pode ser uma URL remota, mas normalmente é uma referência relativa a uma imagem da pasta [images/](https://github.com/LacunaSoftware/docs/tree/master/images).

Por exemplo, para referenciar a imagem [images/pki-sdk/pades-rectangle.png](https://github.com/LacunaSoftware/docs/blob/master/images/pki-sdk/pades-rectangle.png) a partir dos seguintes locais:

A partir de `docs.en-us/articles/project-name/article.md`:

```md
![Image name](/images/pki-sdk/pades-rectangle.png)
```

A partir de `docs.en-us/articles/project-name/subfolder/article.md`:

```md
![Image name](/images/pki-sdk/pades-rectangle.png)
```

Exemplos:

* [PKI SDK / Primeiros passos / Adicionando o pacote nuget](https://docs.lacunasoftware.com/articles/pki-sdk/get-started/nuget)
* [Web PKI / Browsers suportados](https://docs.lacunasoftware.com/articles/web-pki/browser-support)

### Citações, notas e avisos

Citações:

```md
As Jeffrey Lebowski once said:

> Far out.
```

As Jeffrey Lebowski once said:

> Far out.

Notas:

```md
:::note
This is an important notice
:::

```

> **Observação**
>
> This is an important notice

Avisos:

```md
:::warning
Watch out!
:::

```

> **Aviso**
>
> Watch out!

Também são suportados:

> **Dica**
>
> Isto é uma dica

> **Info**
>
> Isto é importante

> **Cuidado**
>
> Prossiga com cautela

### Tabelas

```md
First Header                | Second Header
--------------------------- | -------------
Content from cell 1         | Content from cell 2
Content in the first column | Content in the second column
```

First Header                | Second Header
--------------------------- | -------------
Content from cell 1         | Content from cell 2
Content in the first column | Content in the second column

Não é realmente necessário alinhar as colunas; isto gera exatamente o mesmo resultado:

```md
First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column
```

First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column

Para casos mais complexos, por exemplo com a célula superior esquerda em branco, use esta sintaxe um pouco mais complexa:

```md
|     | Second Header |
| --- | ------------- |
| Content from cell 1 | Content from cell 2 |
| Content in the first column | Content in the second column |
```

|     | Second Header |
| --- | ------------- |
| Content from cell 1 | Content from cell 2 |
| Content in the first column | Content in the second column |

> A especificação do Markdown do GitHub (que o DocFX estende) exige pelo menos três hifens (`---`) em cada coluna da linha de cabeçalho (como mostrado acima, na primeira coluna).

A linha de cabeçalho é sempre renderizada em negrito. Se você também precisar da primeira coluna em negrito, faça assim:

```md
|              | Ease of use   | Awesomeness  |
| ------------ | ------------- | ------------ |
| **Web PKI**  | Very easy     | So good      |
| **Rest PKI** | Super easy    | Much awesome |
| **PKI SDK**  | Easy peasy    | Wow          | 
```

|              | Ease of use   | Awesomeness  |
| ------------ | ------------- | ------------ |
| **Web PKI**  | Very easy     | So good      |
| **Rest PKI** | Super easy    | Much awesome |
| **PKI SDK**  | Easy peasy    | Wow          | 

O texto nas células normalmente fica alinhado à esquerda. Para outros alinhamentos:

```md
| Left-aligned | Center-aligned | Right-aligned |
| :---         |     :---:      |          ---: |
| git status   | git status     | git status    |
| git diff     | git diff       | git diff      |
```

| Left-aligned | Center-aligned | Right-aligned |
| :---         |     :---:      |          ---: |
| git status   | git status     | git status    |
| git diff     | git diff       | git diff      |

Veja também:

* [Organizing information with tables - GitHub Help](https://help.github.com/articles/organizing-information-with-tables/)
* Exemplos
	* Tabela com a célula superior esquerda em branco: [Web PKI / Introdução](https://docs.lacunasoftware.com/articles/web-pki)
	* Tabela com texto centralizado: [Web PKI / Browsers suportados](https://docs.lacunasoftware.com/articles/web-pki/browser-support)