= Título
== Título 1
=== Título 2
==== Título 3
Para numerar os títulos, basta adicionar a linha abaixo no topo do documento:
:numbered:
- Item A
- Item B
- Item C
http://palmas.ifto.edu.br
http://palmas.ifto.edu.br[IFTO Palmas]
Se você usar a tag link para outro arquivo .adoc
, tal link só funcionará na interface do GitHub.
Por outro lado, se você está compilando os AsciiDocs para HTML e hospedando como um site convencional
em qualquer lugar como o GitHub Pages (que não exibe a interface do GitHub),
tais links não funcionarão, pois o navegador não interpreta arquivos .adoc
,
somente sites como o GitHub tem essa capacidade.
Por outro lado, se você colocar o link com extensão .html
, vai funcionar na sua hospedagem
mas não vai funcionar na interface padrão do GitHub.
Para resolver esse dilema, neste caso, use o comando xref
no lugar de link
.
A estrutura é exatamente a mesma:
xref:documento.adoc[Documento AsciiDoc]
Tal comando vai gerar um link, incluindo a extensão apropriada, dependendo de onde e como o arquivo AsciiDoc está sendo aberto.
Mas para isso funcionar, é preciso incluir o comando if
abaixo no topo de cada documento:
ifdef::env-github,env-browser[] :outfilesuffix: .adoc endif::[]
|===
| Coluna A | Coluna B | Coluna C
| Célula A1 | Célula B1 | Célula C1
| Célula A2 | Célula B2 | Célula C2
|===
Coluna A |
Coluna B |
Coluna C |
Célula A1 |
Célula B1 |
Célula C1 |
Célula A2 |
Célula B2 |
Célula C2 |
Veja que basta separar as colunas por |
e iniciar e terminar a tabela com |===
.
Você pode destacar os títulos usando negrito, por exemplo, como **Coluna A**.
Imagem no meio do texto.
Um texto image:url-ou-endereço-local[] qualquer aqui.
Um texto aqui.
.Título Opcional
image::url-ou-endereço-local[]
Outro texto aqui. Observe as linhas em branco antes e depois.
A imagem não pode ficar junto com o texto.
Ela deve ficar em uma linha separada.
.Título da Imagem aqui
image::url-ou-endereço-local[]
.Título Opcional
video::SALUHrZz2OQ[youtube]
video::SALUHrZz2OQ[youtube]
video::SALUHrZz2OQ[youtube, width=640, height=480]
Existem 5 tipos de notas, que são blocos no meio do texto para chamar a atenção para algo. A forma simplificada não permite quebra de linha no texto.
NOTE: Texto da nota aqui.
TIP: Texto da dica aqui.
WARNING: Texto do aviso aqui.
CAUTION: Texto de alerta aqui.
IMPORTANT: Texto importante aqui.
📎
|
Esta é uma nota qualquer. |
💡
|
Esta é uma dica qualquer. |
|
Este é um aviso qualquer. |
🔥
|
Este é um alerta qualquer. |
❗
|
Esta é uma informação importante. |
Podemos exibir código em qualquer linguagem que desejarmos dentro de um arquivo adoc. Se precisamos exibir apenas uma única linha de código, basta envolver tal linha entre apóstrofos, como `linha de código aqui`. O exemplo abaixo mostra um texto com um comando Linux no meio, tal comando envolvido em apóstrofos. Assim, o comando fica destacado.
O comando sudo apt-get install asciidoctor
instala o compilador de AsciiDoc em sistemas Ubuntu e derivados de debian.
Podemos incluir conteúdo de qualquer outro arquivo dentro de um arquivo adoc. Tais arquivos devem estar em formato de texto (como arquivos txt, arquivos de configuração, de código fonte, xml, json, sh, etc).
.Titulo opcional
include::caminho-ou-url-do-arquivo[]
Se usarmos o comando acima para incluírmos um documento adoc dentro de outro, não será exibido o código fonte adoc, mas sim o conteúdo final após o adoc ser compilado.
❗
|
O comando include ainda não funciona na interface do GitHub, apenas no GitHub Pages. No GitHub, ele vai apenas criar um link para o arquivo, no lugar de exibir seu conteúdo.
|
Se desejarmos incluir apenas um determinado trecho de um arquivo no nosso documento adoc, podemos delimitar tal trecho dentro do arquivo por meio de uma tag. A tag deve ter um nome, como preferirmos. Se desejarmos incluir um trecho de um arquivo de código fonte como Java, a abertura e fechamento da tag deve estar comentada. Como a tag representa código AsciiDoc e não código Java, se não comentarmos a tag, o código Java não irá compilar.
Depois de escolher o nome para sua tag, para delimitar o bloco de código que podemos selecionar para exibir no documento adoc,
basta delimitar tal bloco com as linhas // tag::nome_da_tag[]
e // end::nome_da_tag[]
, como no exemplo a seguir.
// tag::nome_da_tag[]
Linhas de código
dentro de arquivo de código fonte,
que desejamos exibir apenas o trecho envolvido na tag
// end::nome_da_tag[]
Veja que foi usado //
para comentar a tag pois nosso exemplo é com Java.
Assim, o arquivo Java fica como abaixo:
Veja que o nome da tag foi chamada de main, justamente por envolver apenas o método main()
da classe Java de exemplo.
Para então exibir apenas o trecho delimitado pela tag no arquivo de código fonte, podemos fazer:
.Titulo opcional
include::caminho-ou-url-do-arquivo[tag=nome_da_tag]
O resultado é então como abaixo:
Em todos os exemplos de inclusão de arquivos de código fonte externo,
você pode notar que o código não foi destacado (colorido). Para fazer isto,
basta colocar o include
dentro de um bloco [source]
, indicando
o tipo de conteúdo do arquivo (no exemplo, java) como abaixo:
.Titulo opcional
[source, java]
----
include::caminho-ou-url-do-arquivo[tag=nome_da_tag]
----
Observe que o título (se tiver), agora deve ficar no bloco source
e não no comando include
. O resultado fica então:
link:Teclado.java[role=include]