https://github.com/wlsf82/markdown-lessons-for-great-docs
Lições de markdown para ótimas documentações.
https://github.com/wlsf82/markdown-lessons-for-great-docs
docs documentacao documentation github markdown
Last synced: about 1 month ago
JSON representation
Lições de markdown para ótimas documentações.
- Host: GitHub
- URL: https://github.com/wlsf82/markdown-lessons-for-great-docs
- Owner: wlsf82
- License: mit
- Created: 2023-04-20T22:46:16.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-09T00:51:17.000Z (about 3 years ago)
- Last Synced: 2025-02-06T05:42:23.414Z (over 1 year ago)
- Topics: docs, documentacao, documentation, github, markdown
- Homepage:
- Size: 19.5 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.
```json
{
"name": "Walmyr",
"nationality": "Brazilian",
"maried": true
}
```
Exemplo de bloco de código **HTML** com múltiplas linhas.
```html
Aplicação Exemplo
Título exemplo
Parágrafo exemplo
```
Exemplo de bloco de código **JavaScript** com múltiplas linhas.
```js
// greetings.js
const name = 'Walmyr'
console.log(`Olá ${name}!`)
/*
* Multiple
* Lines
* JS
* Comment
*/
```
Exemplo de bloco de código **shell** com múltiplas linhas.
```sh
pwd
mkdir example/
cd example/
git init
npm init -y
```
Exemplo de bloco de código **Ruby** com múltiplas linhas.
```rb
# 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
## Checkboxes
- [x] Estudar HTML
- [x] Estudar CSS
- [x] Estudar JavaScript
- [ ] Estudar Cypress
- [x] Testes de GUI
- [x] 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](https://walmyr.dev).