- Published on
Guia Markdown
- Authors
- Name
- Full App
Introdução
A análise de Markdown e Mdx é suportada através de pacotes 'unificados', e outros pacotes de observação e reidratação. 'next-mdx-remote' nos permite analisar arquivos '.mdx' e '.md' de uma maneira mais flexível sem tocar no webpack.
Marcação com sabor de Github é usada. 'mdx-prism' fornece recursos de destaque de sintaxe para blocos de código. Aqui está uma demonstração de como tudo parece.
A seguinte planilha de cheatdown é adaptada de: https://guides.github.com/features/mastering-markdown/
O que é Markdown?
Markdown é uma maneira de estilizar texto na web. Você controla a exibição do documento; formatar palavras como ousadas ou itálicas, adicionar imagens e criar listas são apenas algumas das coisas que podemos fazer com Markdown. Na maioria das vezes, Markdown é apenas um texto regular com alguns caracteres não alfabéticos jogados, como '#' ou '*'.
Syntaxe
Aqui está uma visão geral da sintaxe do Markdown que você pode usar em qualquer lugar em GitHub.com ou em seus próprios arquivos de texto.
Cabeçalhos
# This is a h1 tag
## This is a h2 tag
#### This is a h4 tag
This is a h1 tag
This is a h2 tag
This is a h4 tag
Emfase
_This text will be italic_
**This text will be bold**
_You **can** combine them_
This text will be italic
This text will be bold
You can combine them
Listas
Desordem
- Item 1
- Item 2
- Item 2a
- Item 2b
- Item 1
- Item 2
- Item 2a
- Item 2b
Orden
1. Item 1
1. Item 2
1. Item 3
1. Item 3a
1. Item 3b
- Item 1
- Item 2
- Item 3
- Item 3a
- Item 3b
Images
![GitHub Logo](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)
Format: ![Alt Text](url)
Links
http://github.com - automatic!
[GitHub](http://github.com)
http://github.com - automatic! GitHub
Blockquotes
As Kanye West said:
> We're living the future so
> the present is our past.
As Kanye West said:
We're living the future so the present is our past.
Código Inline
I think you should use an
`<addr>` element here instead.
I think you should use an
<addr>
element here instead.
Sintaxe highlighting
Here’s an example of how you can use syntax highlighting with GitHub Flavored Markdown:
```js:fancyAlert.js
function fancyAlert(arg) {
if (arg) {
$.facebox({ div: '#foo' })
}
}
And here's how it looks - nicely colored with styled code titles!
function fancyAlert(arg) {
if (arg) {
$.facebox({ div: '#foo' })
}
}
Task Lists
- [x] list syntax required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item
- list syntax required (any unordered or ordered list supported)
- this is a complete item
- this is an incomplete item
Tabelas
Você pode criar tabelas montando uma lista de palavras e dividindo-as com hífens '-' (para a primeira linha), e depois separando cada coluna com um tubo '|':
| First Header | Second Header |
| --------------------------- | ---------------------------- |
| Content from cell 1 | Content from cell 2 |
| Content in the first column | Content in the second column |
First Header | Second Header |
---|---|
Content from cell 1 | Content from cell 2 |
Content in the first column | Content in the second column |
Strikethrough
Any word wrapped with two tildes (like ~~this~~
) will appear crossed out.