Skip to content

Lições de markdown para ótimas documentações.

License

Notifications You must be signed in to change notification settings

wlsf82/markdown-lessons-for-great-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Lições de Markdown para ótimas documentações

h2

Parágrafo exemplo...

h3

h4

h5
h6

Exemplo de bloco de código sem definição de linguagem com múltiplas linhas.

{
  "name": "Walmyr",
  "nationality": "Brazilian",
  "maried": true
}

Exemplo de bloco de código JSON com múltiplas linhas.

{
  "name": "Walmyr",
  "nationality": "Brazilian",
  "maried": true
}

Exemplo de bloco de código HTML com múltiplas linhas.

<!-- index.html -->

<!DOCTYPE html>
<html lang="PT-BR">
  <head>
    <title>Aplicação Exemplo</title>
  </head>
  <body>
    <h1>Título exemplo</h1>
    <p>Parágrafo exemplo</p>
  </body>
</html>

Exemplo de bloco de código JavaScript com múltiplas linhas.

// greetings.js

const name = 'Walmyr'

console.log(`Olá ${name}!`)

/*
 * Multiple
 * Lines
 * JS
 * Comment
 */

Exemplo de bloco de código shell com múltiplas linhas.

pwd
mkdir example/
cd example/
git init
npm init -y

Exemplo de bloco de código Ruby com múltiplas linhas.

# sum.rb

def sum(a, b)
  a+b
end

Exemplo de código inline a seguir: npm install example -S

Listagem não-numerada

  • Foo
  • Bar
  • Baz

Listagem não-numerada com recuo

  • Foo
  • Bar
  • Baz
    • Bah
    • Bãeih

Listagem numerada

  1. Item 1
  2. Item 2
  3. Item 3

Listagem numerada com recuo

  1. Item 1
  2. Item 2
  3. Item 3
    1. Item a
    2. Item b
  4. Item 4

Outro h2

Exemplo de botão.

Expandable and collapsible

Abra para ver mais detalhes
Informação detalhada aqui.

Blablabla.

...

Citações (Quotes)

Uma linha

Como as pessoas tratam você é o karma delas; como você reage é o seu. Wayne Dyer

Múltiplas linhas

Não contavam com minha astúcia!

Chapolin Colorado

Blocos de citação aninhados

Dorothy a seguiu por muitos dos belos aposentos de seu castelo.

A Bruxa ordenou que ela limpasse as panelas e chaleiras, varresse o chão e mantivesse o fogo alimentado com lenha.

Bloco de citação com outros elementos

Os resultados do último trimestre parecem ótimos!

  • Receita
  • Lucro

Tudo está de acordo com os planos.

Imagens

Tux, o mascote do Linux

Checkboxes

  • Estudar HTML
  • Estudar CSS
  • Estudar JavaScript
  • Estudar Cypress
    • Testes de GUI
    • Testes de API
    • Testes de Componentes

Tabelas

ID isAvailable stockQty
00001 true 257
00002 false 0

Strikethrough

Use Cypress com Cucumber e Page Objects utilizando sua estrutura padrão.

Link

Automático

https://example.com

Desabilitado

https://example.com


Feito com 💚 por Walmyr.

About

Lições de markdown para ótimas documentações.

Topics

Resources

License

Stars

Watchers

Forks