Pular para o conteúdo principal

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

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
  2. 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:

# Article title

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

ou

# 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:

Guia rápido de Markdown​

Esta é a sintaxe dos elementos mais comuns:

Títulos​

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

# Article title

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

## Section title

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

### Subsection title

Negrito​

This is a **bold** statement

This is a bold statement

Itálico​

This is a *foreign word*.

This is a foreign word.

Código inline​

Pass the `callback` parameter

Pass the callback parameter

Listas​

Não ordenada:

* 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:

1. Item 1
1. Item 2
   1. Subitem (prefix spaces to align with parent)
      1. And so on
1. Item 3
  1. Item 1
  2. Item 2
    1. Subitem (prefix spaces to align with parent)
      1. And so on
  3. 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:

Something

***

Some other thing
observação

Não use a sintaxe ---, pois ela tem um significado especial no DocFX

[text](url)

Para artigos na mesma pasta:

See the article [Welcome](index.md)

See the article Welcome

Para artigos em outras pastas:

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

You can use the Lacuna PKI SDK for this purpose

Para classes:

See class @Lacuna.RestPki.Client.RestPkiClient

See class @Lacuna.RestPki.Client.RestPkiClient

Para métodos:

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:

<xref:Lacuna.RestPki.Client.RestPkiClient>

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

<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:

## 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:

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

See Default error callback

Trechos de código​

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

    2. Execute isto:

      sudo apt install something

    3. Finalize

  2. Pronto

Veja todos os nomes e aliases de linguagem suportados.

Includes​


{/* include: url */}

Blocos de include comuns aos dois idiomas ficam na pasta includes/. Por exemplo, para incluir o bloco rest-pki-samples-matrix.md a partir de um local como docs.en-us/articles/project-name/article.md:


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

Exemplo: Rest PKI

Inclusão de trechos de código​

Imagens​

![Alt Text](url)

url pode ser uma URL remota, mas normalmente é uma referência relativa a uma imagem da pasta images/.

Por exemplo, para referenciar a imagem images/pki-sdk/pades-rectangle.png a partir dos seguintes locais:

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

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

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

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

Exemplos:

Citações, notas e avisos​

Citações:

As Jeffrey Lebowski once said:

> Far out.

As Jeffrey Lebowski once said:

Far out.

Notas:

:::note
This is an important notice
:::

observação

This is an important notice

Avisos:

:::warning
Watch out!
:::

aviso

Watch out!

Também são suportados:

dica

Isto é uma dica

info

Isto é importante

cuidado

Prossiga com cautela

Tabelas​

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

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

First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column
First HeaderSecond Header
Content from cell 1Content from cell 2
Content in the first columnContent 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:

|     | 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 1Content from cell 2
Content in the first columnContent 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:

|              | Ease of use   | Awesomeness  |
| ------------ | ------------- | ------------ |
| **Web PKI**  | Very easy     | So good      |
| **Rest PKI** | Super easy    | Much awesome |
| **PKI SDK**  | Easy peasy    | Wow          |
Ease of useAwesomeness
Web PKIVery easySo good
Rest PKISuper easyMuch awesome
PKI SDKEasy peasyWow

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

| Left-aligned | Center-aligned | Right-aligned |
| :---         |     :---:      |          ---: |
| git status   | git status     | git status    |
| git diff     | git diff       | git diff      |
Left-alignedCenter-alignedRight-aligned
git statusgit statusgit status
git diffgit diffgit diff

Veja também:

Ver em Markdown