Markdown: Elementos Essenciais para Documentos do Sistema Quarto

Markdown

Linguagem de Marcação

Reprodutibilidade

Um tutorial simples sobre a linguagem de marcação Markdown para elaboração de documentos no sistema Quarto.

Autor

Afiliação

Prof. Dr. Washington S. da Silva

IFMG - Campus Formiga - Mestrado Profissional em Administração.

Data de Publicação

5 setembro 2024

1 Introdução

Objetivos deste Tutorial

Este tutorial apresenta os elementos essenciais do Markdown para a criação de documentos no sistema Quarto. Ao final, você será capaz de:

Criar documentos bem estruturados com Markdown
Formatar textos com ênfases diferentes
Inserir listas, links e imagens
Incluir equações matemáticas simples
Criar tabelas básicas

O que é Markdown?

Markdown é uma linguagem de marcação leve, criada para converter texto simples em documentos formatados. Principais vantagens:

Simplicidade: Fácil de aprender e usar.
Foco no conteúdo: Concentre-se no que escreve, não em como formatar.
Flexibilidade: Funciona em diferentes plataformas.
Conversão: Gera documentos em diversos formatos (html, pdf, docx).

2 Elementos Básicos do Markdown

2.1 Cabeçalhos

Os cabeçalhos são criados usando o símbolo #:

# Título Principal (H1)
## Subtítulo (H2)
### Seção (H3)
#### Subseção (H4)
##### Tópico (H5)
###### Subtópico (H6)

2.2 Parágrafos e Formatação de Texto

Em Markdown, os parágrafos são criados através de linhas em branco. Para iniciar um novo parágrafo, basta deixar uma linha vazia entre os blocos de texto.

Este é o primeiro parágrafo.

Este é o segundo parágrafo. Note a linha em branco 
entre eles.

Resultado:

Este é o primeiro parágrafo.

Este é o segundo parágrafo. Note a linha em branco entre eles.

Para criar uma quebra de linha sem iniciar um novo parágrafo (quebra de linha simples), adicione dois espaços no final da linha ou use a tag HTML <br>.

Esta linha termina com dois espaços  
e continua aqui na próxima linha.

Esta linha usa a tag HTML.<br>E continua aqui.

Resultado:

Esta linha termina com dois espaços
e continua aqui na próxima linha.

Esta linha usa a tag HTML.
E continua aqui.

2.3 Formatação de Texto

*Este texto será em itálico* e _este também_

**Este texto será em negrito** e __este também__

***Este texto será em negrito e itálico***

~~Este texto aparecerá riscado~~

`código inline` (útil para comandos, variáveis ou 
termos técnicos)

Resultado:

Este texto será em itálico e este também

Este texto será em negrito e este também

Este texto será em negrito e itálico

~~Este texto aparecerá tachado~~

código inline (útil para comandos, variáveis ou termos técnicos)

2.4 Listas

2.4.1 Listas Não-Ordenadas

- Primeiro item
- Segundo item
  - Subitem 2.1
  - Subitem 2.2
- Terceiro item

Resultado:

Primeiro item
Segundo item
- Subitem 2.1
- Subitem 2.2
Terceiro item

Alternativas: asteriscos (*) e (+) também podem ser usados para criar listas não ordenadas.

2.4.2 Listas Ordenadas

1. Primeiro passo
2. Segundo passo
   1. Subtarefa 2.1
   2. Subtarefa 2.2
3. Terceiro passo

Resultado:

Primeiro passo
Segundo passo
1. Subtarefa 2.1
2. Subtarefa 2.2
Terceiro passo

2.4.3 Listas de Tarefas

- [x] Tarefa concluída
- [ ] Tarefa pendente
- [ ] Tarefa a fazer

Resultado:

Tarefa concluída
Tarefa pendente
Tarefa a fazer

2.5 Links

[Texto do link](https://www.exemplo.com)

Exemplo:

IFMG - Campus Formiga

2.6 Imagens

Para incluir imagens externas em seus documentos:

![Texto alternativo](img/imagem.jpg)

No Quarto, você pode adicionar atributos como largura e alinhamento:

![](imagens/foto.jpg){width=60% fig-align="center"}

3 Escrevendo matemática com LaTeX

LaTeX

LaTeX (pronuncia-se “Lah-tech” ou “Lay-tech”) é um sistema de preparação de documentos de alta qualidade, amplamente utilizado na academia, no mundo corporativo e em publicações científicas.

Desenvolvido por Leslie Lamport nos anos 1980, o LaTeX é uma extensão do sistema de composição tipográfica TeX, criado por Donald Knuth.

Diferentemente de processadores de texto tradicionais como Microsoft Word, o LaTeX funciona como uma linguagem de marcação, onde o autor escreve o conteúdo junto com comandos que definem a estrutura lógica e a formatação do documento. O sistema então processa esse código para gerar documentos com aparência profissional.

Características principais:

Qualidade tipográfica superior: Especialmente para fórmulas matemáticas, equações e notações científicas complexas.
Separação entre conteúdo e formatação: Permite ao autor focar no conteúdo enquanto o sistema gerencia a apresentação.
Estabilidade e consistência: Mantém formatação uniforme através de documentos extensos.
Referências cruzadas automatizadas: Facilita a criação e manutenção de citações, notas de rodapé e bibliografias.
Extensibilidade: Através de pacotes adicionais que expandem suas funcionalidades

3.1 Integração com Markdown:

Muitos sistemas baseados em Markdown, incluindo o sistema Quarto, permitem a incorporação de expressões LaTeX diretamente no texto. Esta integração é especialmente útil para incluir equações matemáticas em documentos:

3.1.1 Expressões Matemáticas Inline

Use $...$ para inserir expressões matemáticas LaTeX em linha com o texto:

A fórmula da área do círculo é $A = \pi r^2$, 
sendo $r$ o raio.

Resultado:

A fórmula da área do círculo é A = \pi r^2, onde r é o raio.

3.1.2 Blocos de Equações

Use $$...$$ para equações em destaque:

A equação quadrática e sua solução:

$$
ax^2 + bx + c = 0
$$

$$
x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
$$

Resultado:

A equação quadrática e sua solução:

ax^2 + bx + c = 0

x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}

3.1.3 Exemplos de Expressões Matemáticas Úteis

Frações: 

$$
\frac{numerador}{denominador}$
$$

Somatório: 

$$
\sum_{i=1}^{n} x_i
$$

Produtório: 

$$
\prod_{i=1}^{n} x_i
$$

Integral: 

$$
\int_{a}^{b} f(x) dx
$$

Limite: 

$$
\lim_{x \to \infty} f(x)
$$

Resultado:

Frações:

\frac{numerador}{denominador}

Somatório:

\sum_{i=1}^{n} x_i

Produtório:

\prod_{i=1}^{n} x_i

Integral:

\int_{a}^{b} f(x) dx

Limite:

\lim_{x \to \infty} f(x)

4 Tabelas

Tabelas em Markdown são criadas usando barras verticais e hífens:

| Produto   | Preço (R$) | Estoque |
|-----------|------------|---------|
| Produto A | 25,90      | 42      |
| Produto B | 15,50      | 38      |
| Produto C | 32,80      | 12      |

Resultado:

Produto	Preço (R$)	Estoque
Produto A	25,90	42
Produto B	15,50	38
Produto C	32,80	12

Alinhamento nas colunas:

| Produto   | Preço (R$) | Estoque |
|:----------|:----------:|---------:|
| Esquerda  | Centro     | Direita  |

5 Citações em Bloco

> Esta é uma citação em bloco.
> Continua na próxima linha.
>
> Este é um novo parágrafo na mesma citação.

Resultado:

Esta é uma citação em bloco. Continua na próxima linha.

Este é um novo parágrafo na mesma citação.

6 Elementos Especiais do Sistema Quarto

6.1 Callouts (Caixas de Destaque)

O Quarto oferece caixas para destacar informações.

Esses recursos funcionam perfeitamente para arquivos html e funcionam, mas não tão perfeitamente, em arquivos pdf produzidos pelo Typst.

::: {.callout-note}
## Nota

Uma informação importante a considerar.
:::

::: {.callout-tip}
## Dica

Uma sugestão para melhorar seu documento.
:::

::: {.callout-warning}
## Atenção

Um aviso para tomar cuidado.
:::

Resultado:

Nota

Uma informação importante a considerar.

Dica

Uma sugestão para melhorar seu documento.

Atenção

Um aviso para tomar cuidado.

7 Dicas Práticas

Seja consistente na estrutura e formatação.
Divida o conteúdo em seções lógicas.
Use cabeçalhos para criar uma hierarquia clara.
Revise a visualização do documento regularmente.
Mantenha imagens em uma pasta separada (img) e organizada.
Aprenda gradualmente - comece com os elementos básicos.

8 Conclusão

Markdown é uma linguagem simples e poderosa para criar documentos no sistema Quarto. Com este tutorial básico, você já pode começar a escrever documentos bem formatados, adicionando posteriormente elementos mais avançados conforme sua necessidade e familiaridade com a linguagem e com o sistema Quarto.

9 Glossário de Termos

L

Linguagem de Marcação: Sistema de anotações inseridas em um texto para definir como ele deve ser estruturado, formatado ou apresentado. Ao contrário das linguagens de programação que executam comandos, as linguagens de marcação utilizam tags ou comandos para identificar elementos do documento (como títulos, parágrafos, listas) sem se preocupar com a lógica computacional. Exemplos incluem HTML (para páginas web), XML (para dados estruturados), LaTeX (para documentos científicos) e Markdown (usada no Quarto para formatação simplificada de texto).