Índice
O que é MarkdownÉ definido tanto quanto o software escrito em Porl, que converte o texto escrito em HTML e, adicionalmente, na sintaxe usada para chegar ao resultado HTML que esperamos. Uma sintaxe desenhada para ser simples para quem deseja escrever na web, sem a necessidade de conhecê-la.
Hoje a maioria dos gerenciadores de conteúdo e até mesmo muitos clientes de e-mail suportam o uso da sintaxe Markdown, nativamente, isso com o intuito de facilitar a criação de textos formatados sem a necessidade de implementar estilos ou saber HTML. Esses manipuladores usam um analisador para converter o texto Markdown em HTML.
MarkDown e Documentação
É muito útil aprender muitas ferramentas de documentação com markdown; wikia, onenote, evernote, alfresco suportam nativamente, ou com a ajuda de terceiros. É importante ter a documentação dos processos e possíveis problemas, mas ainda mais importante é mantê-la organizada e limpa, mesmo no console, e o markdown está aqui para nos ajudar com isso.
Parágrafos
Se estivéssemos escrevendo normalmente em um editor comum, para definir um parágrafo, simplesmente pressionaríamos alguns dos seguintes itens:
Digitar
E veremos nosso cursor ir algumas linhas abaixo para escrever em um novo parágrafo.Em HTML é conhecido como do parágrafo.
No Markdown é tão fácil quanto em um editor normal.
Além disso, temos a vantagem de que uma única quebra de linha não separa o texto em várias linhas, se escrevermos algo assim:
Um texto. Outro texto.Isso parecerá assim:
Um texto. Outro texto.O uso de várias linhas separadoras também reduz a um único espaço separador entre os parágrafos
Cabeçalhos
Em um editor normal, precisaríamos da barra de ferramentas para definir um estilo de título para um texto, ou se você se sentir um pouco confuso, seria suficiente ir até o tamanho da fonte e torná-lo em negrito.
Em HTML, eles são conhecidos como
,
, etc, do cabeçalho.
No Markdown é muito simples, basta colocar o caractere numérico (#) como prefixo do cabeçalho, quanto mais destes tiver o grau mais baixo o cabeçalho terá no máximo 6.
Por exemplo, um cabeçalho (o maior) e um eles seriam escritos assim:
# Cabeçalho grande ### Cabeçalho pequeno
e o resultado será assim.
No Markdown é muito simples, basta colocar o caractere numérico (#) como prefixo do cabeçalho, quanto mais destes tiver o grau mais baixo o cabeçalho terá no máximo 6.
Por exemplo, um cabeçalho (o maior) e um eles seriam escritos assim:
# Cabeçalho grande ### Cabeçalho pequenoe o resultado será assim.
Ótimo cabeçalho
Cabeçalho pequeno
Normalmente não é possível desenhar separadores em editores simples.
PROLONGAR
Em HTML eles se tornam de regras horizontais.Eles são delimitados digitando 3 ou mais asteriscos ou hifens. Eles podem ser seguidos ou separados por um espaço, é indiferente.
* * * *** - - - ---Ênfase
Essa formatação é conhecida como itálico e negrito.
Em HTML seria Y .
Para criar um texto com formato itálico, basta colocar o texto entre asteriscos simples ou sublinhados e, para negrito, entre duplos:
* texto em itálico. * _ texto em itálico._ ** texto em negrito. ** __bold text .__Seria mais ou menos assim:
texto em itálico. texto em negrito.
Tachado
Isso permite que você coloque o texto como se o estivéssemos riscando, muito usado para controle de versão. o Bugs que foram corrigidos em um aplicativo ou sistema.
EM HTML, seria tachado.
Basta colocar o texto entre maiúsculas duplas ou til:
~~ texto tachado. ~~Esta opção não é um padrão e pode não funcionar em todos os editores.
Citações
O estilo de citação geralmente não é facilmente encontrado em um editor de texto comum
Em HTML seria
.
Nós apenas temos que colocar o caractere "maior que" (>) como um prefixo para o texto que segue (semelhante ao endereçamento no Linux)> Esta é uma citação.Pareceria:Esta é uma citação.
Listas
Para definir uma lista de objetivos costumamos usar a funcionalidade de marcadores para listas sem ordem específica e listas numeradas.
Em HTML seria para listas não ordenadas, para listas ordenadas e para definir cada item da lista.
No Markdown, nós os definimos simplesmente prefixando cada item com um asterisco (*), traço (-) ou símbolo de adição (+) para listas não ordenadas. Para listas ordenadas, prefixamos com o número correspondente e um ponto:* Escreva tutorial * Publique no Solvetic. 1. Novo tutorial. 3. Escolha uma seção e nível. 2. Corrija os formatos e publique.Ficaria assim:
- Escreva o tutorial.
- Publique no Solvetic.
Nas listas enumeradas, a hierarquia do número não é respeitada, a posição dentro delas será usada.
- Novo tutorial.
- Escolha uma seção e nível.
- Formatos corretos e publicação.
Links
Colocar links é extremamente útil e importante, pois permite que você faça referência ao conteúdo de alguma documentação externa ou de um tutorial.
Exemplo:O servidor Nginx foi protegido com fail2ban usando [tutorial-solvetic] (http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-y-nginx/)Colocamos entre colchetes [] o texto que queremos tem o link e então colocamos entre parênteses () o link de destino.
Se preferir fazê-lo de forma mais ordenada do que ter as referências no meio do texto, também pode fazê-lo da seguinte forma:O servidor Nginx foi protegido com fail2ban usando [1] ……… [1]: http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-y- nginx /Outra opção seria:O servidor Nginx foi protegido com fail2ban usando [fail2ban-nginx-solvetic] ……… [ssh-nginx-solvetic]: http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo - con-ssh-y-nginx /Agora adicione imagens.
Imagens
Podemos adicionar imagens quase semelhantes a links adicionando um! Antes de cada um, devo enfatizar não poder vê-los de um terminal, bem, não diretamente.! [texto alternativo] (url-imagem)Podemos usar as mesmas opções dos links se quisermos ter mais organizado.
Pranchas
Costumo colocar dados de acesso em tabelas de servidores ou serviços.
Para fazer isso, desenhamos as linhas da tabela com barras verticais (|) para delimitar as colunas e hífens (-) para separar o cabeçalho do resto das linhas:| Serviço | Usuário | Chave | | ------------- | --------- | ----------- | | FTP | solvético | aw-D.wak | | SSH | admin | 2 horas da manhã, |Teríamos algo assim:
Os tubos não precisam ser alinhados, e as "bordas" são opcionais, por exemplo:Título 1 | Título 2 --- | --- vamos tentar | algo vamos tentar alguns | outra coisa. Isso geraria a mesma tabela.Você também pode alinhar o texto em suas colunas, colocando o símbolo de dois pontos ( no hífen feito separador no lado que deseja alinhar:| Esquerda alinhada. | Centrado | Alinhado à direita. | |: ------------------- |: --------: | ----------------- -: | | teste | teste | teste |Nem todos os editores aceitam tabelas no Markdown.
Código
Podemos destacar nosso código com markdown e ele difere de uma linguagem para outra.Sintaxe de crase tripla
Colocar este tipo de blocos é muito fácil, basta incluir o bloco de código que queremos inserir.e 3 crases (`` ``) seguido pelo nome do idioma ao qual pertence o código que você deseja colocar:`` `linguagem x = y …` ``Um exemplo de código JavaScript seria mais ou menos assim:`` `` js function test () {console.log ('testing!')} ''Isso geraria um bom bloco de código com sintaxe destacada para javascript:teste de função () {console.log ('teste!')}Sintaxe de pré-espaçamento
Outra forma de inserir texto ou código pré-formatado, mas sem o idioma especificado, é "recuar" nosso texto com 4 espaços, o escreveríamos assim:x = y // observe que há 4 espaços entre a margem e o que escrevemos.teremos este resultado:x = y // observe que há 4 espaços entre a margem e o que escrevemos.O padrão só aceita a opção com pré-espaçamento.
ConclusõesUm bom sistema de Documentação deve ser rápido, flexível e simples. Pontos que o markdown cobre muito bem, não podemos esquecer sua sintaxe limpa para os olhos, algo a levar em conta se quisermos revisar a documentação de um terminal usando VIM / EMACS. O verbete tem uma abordagem para administradores de sistema, mas pode ser muito útil para todos os tipos de profissionais ou estudantes, espero que qualquer dúvida ou sugestão tenha sido esclarecida, deixe nos comentários.Gostou e ajudou este tutorial?Você pode recompensar o autor pressionando este botão para dar a ele um ponto positivo