Escrevendo Artigos\color{Blue}\Huge\mathbf{Escrevendo}\ \newline\mathbf{Artigos}

Name Date Remarks Version
Giovani Perotto Mesquita 29/10/2024 Criação 1
Giovani Perotto Mesquita 13/11/2024 Ajuste nos links 1

Índice

  1. Introdução
  2. Pré-requisitos
  3. Documento
  4. Referências Bibliograficas

Introdução↩︎

Neste artigo iremos sugerir um template para criação de artigos em markdown[1], que podem ser facilmente renderizados utilizando o vscode.

O nosso objetivo é do trazer uma alternativa grátis e que possa ser utilizado tanto online quanto offline, suportada por diversas plataformas e ferramentas.

Pré-requisitos↩︎

Utilizaremos os seguintes requisitos de software, para escrever os artigos:

Conhecimento (não mandatório) em:

Documento↩︎

Estrutura↩︎

O artigo será estruturado de 4 partes:

Já o conteúdo poderá ser sub-dividido em:

TítuloÍndiceConteúdoCapítuloTópicoTextoDetalhe0 ... n0 ... 10 ... n0 ... 11Referências1 ... n

Título↩︎

O Título é uma frase que identifica o artigo, deve ser único entre os seus demais artigos, para evitar sobreposições. Também deve-se colocar a identificação do autor e a data que o mesmo foi redigido, bem como revisões posteriores e suas datas.

Sintaxe:

# $$\color{Blue}\Huge<<título1>>\ \newline\color{Blue}\Huge<<título1>>$$

Exemplo:

# $$ \color{Blue}\Huge As\ leis\ \newline fundamentais\ \newline da estupidez\ \newline humana $$

Num artigo é importante o registro de revisões.

Sintaxe:

|**Name**|**Date**|**Remarks**|**Version**|
| :- | :- | :- | :- |
|[AuthorName]|[Date]|Initial Requirements Specification|1|
|[AuthorName]|[Date]|[Remarks]|[#]|
|||||
|||||

Exemplo:

Name Date Remarks Version
[AuthorName] [Date] Initial Requirements Specification 1
[AuthorName] [Date] [Remarks] [#]

Índice↩︎

O índice é uma lista das partes de um artigo, organizado pela ordem em que as partes aparecem. O mesmo possui relevância para uma acesso rápido a tôpicos do artigo.

Sintaxe:

1. [<<Capítulo/Tópico/Detalhe>>](#_tocnnn)

Exemplo:

1. [Introdução](#_toc001)
1. [Pré-requsitos](#_toc002)
1. [Documento](#_toc003)
   - [Estrutura](#_toc0031)
     - [Título](#_toc00311)
     - [Índice](#_toc00312)
1. [Referências](#_toc004)

A ligação ao Capítulo/Tópico/Detalhe é efetuado quando da declaração do mesmo, através de um hyperlink (ex.: _toc001). Utilizaremos hyperlink para evitar problemas com acentuação e permitir apontamentos com o mesmo nome.

Sintaxe:

# <a name="_tocnnn"></a><<Capítulo/Tópico/Detalhe>>[↩︎](#_tocnnn)

Exemplo:

# <a name="_toc001"></a>Introdução[↩︎](#_toc000)
# <a name="_toc002"></a>Pré-requsitos[↩︎](#_toc000)
# <a name="_toc003"></a>Documento[↩︎](#_toc000)
## <a name="_toc0031"></a>Estrutura[↩︎](#_toc003)
### <a name="_toc00311"></a>Título[↩︎](#_toc0031)
### <a name="_toc00312"></a>Índice[↩︎](#_toc0031)
 ...

Convencionamos que:

Capítulo será iniciado com ##
Tópico será iniciado com ###
Detalhe será iniciado com ###

E que os hyperlinks serão numerados em ordem sequencial conforme a estrutura, por exemplo: se o capítulo for _toc001 o tópico filho se houver será _toc0011, o segundo será _toc0012, etc...

De mesma forma se o tópico tiver detalhe o mesmo será sequencial, exemplo o tópico _toc0011 o seu filho será _toc00111, _toc00112, etc ...

<a name="_tocnnn"></a><<Capítulo/Tópico/Detalhe>>

Na declaração do Capítulo/Tópico/Detalhe iremos ter um apontamento para o nível anterior, ou seja:

detalhe --> tópico
tópico --> capítulo
capítulo --> índice

Sintaxe:

[↩︎](#_tocnnn)

Outra convenção será que o hyperlink do índice será _toc000, e que todos os capítulos irão apontar para ele na sua declaração.

Exemplo:

# <a name="_toc001"></a>Introdução[↩︎](#_toc000)

Conteúdo↩︎

Conteúdo é basicamente tudo o que você consome ou cria em termos de informação, entretenimento, ou educação. Pode ser um texto, imagem, vídeo, áudio, gráfico, arte, etc. É algo que tem valor para quem recebe, seja para informar, entreter, educar ou inspirar. Pense em um artigo de blog, um post nas redes sociais, um podcast, ou até um meme engraçado. Todos são tipos de conteúdo.

Capítulo↩︎

Capítulo é uma especialização do Conteúdo, afim de criar itens que ajudam na compreensão do Conteúdo.

Tópico↩︎

Tópico é uma especialização do Capítulo, afim de criar itens que ajudam na compreensão do Capítulo.

Detalhe↩︎

Detalhe é uma especialização do Tópico, afim de criar itens que ajudam na compreensão do Tópico.

Texto↩︎

É o assunto a ser transcorrido, podento ser texto, imagem, vídeo, áudio, gráfico, arte, etc. Para isso usamos a linguagem markdown[1:2], afim de realizar a sua formatação. Alguns padrões foram estabelecidos:

Links↩︎

Referência de citação↩︎

Bloco de citação↩︎

[!NOTE]
Highlights information that users should take into account, even when skimming.

[!TIP]
Optional information to help a user be more successful.

[!IMPORTANT]
Crucial information necessary for users to succeed.

[!WARNING]
Critical content demanding immediate user attention due to potential risks.

[!CAUTION]
Negative potential consequences of an action.

Metadados↩︎

exemplo:

title: "Guia Completo de Markdown"
description: "Aprenda tudo sobre Markdown com este guia completo e detalhado."
keywords: ["Markdown", "Guia", "Tutoriais"]
author: "Seu Nome"
layout: post
categories: [programação, tutoriais]
tags: [Markdown, GitHub, Documentação]
date: 2024-11-13
published: true
permalink: /guia-completo-markdown/
excerpt: "Este guia cobre todos os aspectos do Markdown, desde o básico até tópicos avançados."
last_modified_at: 2024-11-13

PlantUML↩︎

Podemos inserir uma renderização PlantUML dentro do markdown.

Sintaxe:

```plantuml
@startuml
skinparam handwritten true
note as N1 #white
 **Tag:** <<//ID tag//>>     **Prioridade:** <<//grau//>>

 **Descrição:** <<//user story//>>

 **Prazo:** <<//DD/MM/YYYY//>>

 **Responsável:** <<persona>>
end note
@enduml

exemplo:

Tag:«ID tag»Prioridade:«grau» Descrição:«user story» Prazo:«DD/MM/YYYY» Responsável:«persona»

LaTEX↩︎

Podemos inserir uma renderização LaTEX dentro do markdown.

Sintaxe:

$$\large \boxed{\text{Flow Efficiency \%} = \frac{\text{Tempo de Trabalho Real}}{\text{Tempo Total de Processamento}}* 100}$$

exemplo:

Flow Efficiency %=Tempo de Trabalho RealTempo Total de Processamento∗100\large \boxed{\text{Flow Efficiency \%} = \frac{\text{Tempo de Trabalho Real}}{\text{Tempo Total de Processamento}}* 100}

Referências Bibliograficas↩︎

As referências bibliográficas é efetuada pela seguinte sintaxe:

Referências Bibliograficas↩︎

  1. "Markdown", Wikipedia, 30/10/2024, https://en.wikipedia.org/wiki/Markdown. ↩︎ ↩︎ ↩︎

  2. "PlantUML at a Glance", PlantUML, 30/10/2024, https://plantuml.com/. ↩︎

  3. "The LaTEX Project", LaTEX, 30/10/2024, https://www.latex-project.org/. ↩︎

  4. "Graphviz", Graphviz, 30/10/2024, https://graphviz.org/. ↩︎