Qual arquivo usa a extensão .md e como devo editá-los?


879

No GitHub, vários projetos têm README.md arquivos. Parece um arquivo de formato simples para expressar texto e imagens.

Eu acho que existe um editor ou explicação de sintaxe em algum lugar.

Onde posso encontrar uma introdução aos .mdarquivos?


38
Eu acho que esta é uma evidência em favor do uso da .markdownextensão em vez disso, que seja tão terrivelmente longo ...
— endolith

7
Aqui está um link que pode ajudá-lo -> .MD File Extension
— Vipin Kr. Singh

1
O MarkPad é um ótimo aplicativo para edição do MarkDown no Windows. Apresenta a visualização das edições.
— precisa saber é o seguinte

1
O usuário pode experimentar o MarkView , uma extensão do Chrome para editar e visualizar arquivos de remarcação dentro do navegador.
— swcool

1
Guia completo para ajudá-lo a começar com markdown: blog.wax-o.com/2014/04/… . Você deve tentar escrever uma remarcação com uma maneira de viver visualizando o resultado (com um aplicativo como mouapp.com ). Você sabia que a sintaxe de postagem e comentário do stackoverflow é baseada na remarcação? :) stackoverflow.com/editing-help
— fabien

Respostas:


733

Markdown é um formato de arquivo de texto sem formatação. As extensões .mde .markdownsão apenas arquivos de texto escritos na sintaxe do Markdown . Se você tiver um Readme.mdno seu repo, o GitHub mostrará o conteúdo na página inicial do seu repo. Leia a documentação:

Você pode editar o Readme.mdarquivo no próprio GitHub. Clique em Readme.md, você encontrará um botão de edição. Você pode visualizar suas alterações e até mesmo enviá-las a partir daí.

Por ser um arquivo de texto, o Bloco de notas ou o Notepad ++ (Windows), o TextEdit (Mac) ou qualquer outro editor de texto podem ser usados ​​para editá-lo e modificá-lo. Existem editores especializados que analisam automaticamente a redução à medida que você digita e geram uma visualização, enquanto outros aplicam várias cores e decorações de sintaxe ao texto exibido. Nos dois casos, o arquivo salvo ainda é um arquivo de texto legível.

Se você deseja criar um mdarquivo com visualização e se preferir não instalar editores especiais, poderá usar editores online como dillinger.io e stackedit.io . Eles fornecem visualização ao vivo. Você também pode exportar seus arquivos para o Google Drive ou Dropbox .


27
Também achei a explicação básica do Github muito útil como uma introdução rápida.
— Voo 28/03

2
No Windows, convém usar o WordPad para usar a formatação para facilitar a leitura.
— L O'Rilla

4
@ GO'Rilla, IMHO evite o WordPad como a praga, a menos que faça pequenas anotações para si mesmo que você nunca compartilhará com ninguém. O que ele adiciona ao arquivo .txt pode causar estragos em outros editores (vim, Notepad ++, etc). É muito melhor trabalhar em texto simples ao lidar com .txt e usar um processador de texto ou Acrobat para arquivos de texto não .txt, como .doc e .pdf.
— labyrinth

1
podemos adicionar imagens ou através do link no arquivo .md ... é possível?
— Raphael

1
@ user1645290 Sim, é possível. Veja também
— B-GangsteR:

87

Se você estiver procurando por um editor, sugiro que você use http://dillinger.io/ . É um editor de texto simples baseado em navegador que pode renderizar Markdown em tempo real.

No entanto, se você preferir um aplicativo e estiver usando o OS X, tente o Mou . É muito bom e cheio de exemplos.


2
Parece estar de volta à vida?
— GuiSim

5
Eu gostaria de sugerir http://dillinger.io/ , outro editor de texto muito bom, baseado em navegador. Também permite vincular o Dropbox, Github e Google drive.
— sirLisko

O link do bloco de notas nesta resposta aciona um download de arquivo RAR. Por que não existe página da Web, você não disse que era um editor baseado em navegador?
— evanrmurphy

esse link não é mais válido
— Carlos Pliego

Apenas salientando que esta não é uma resposta completa para a pergunta. Você não explicar o que Md seja, apenas como ela pode ser editada
— Zoe


33

Código do Visual Studio da Microsoft editor de texto suporte embutido para arquivos .md gravados na sintaxe de remarcação.

A sintaxe é automaticamente codificada por cores dentro do arquivo .md, e uma janela de visualização da redução renderizada pode ser visualizada pressionando Shift+Ctrl+V(Windows) ou Shift+Cmd+V(Mac).

Para vê-los lado a lado, arraste a guia de visualização para o lado direito do editor ou use Ctrl+K V(Windows) ou Cmd+K V(Mac).

insira a descrição da imagem aqui

O VS Code usa a biblioteca marcada para análise e tem o suporte ao Github Flavored Markdown ativado por padrão, mas não exibirá o Emoji do Github em linha, como o editor de texto Atom do Github .

Além disso, o suporte ao VS Code possui vários plugins de descontos disponíveis para funcionalidade estendida.


Se você estiver usando o Visual Studio 2015, veja minha resposta abaixo.
— Bydevev

1
Nota - você pode clicar com o botão direito do mouse no arquivo leia-me> abrir visualização
— Chris Halcrow

15

A extensão ' .md ' refere-se aos arquivos Markdown .

Se você não quiser instalar um aplicativo para lê-lo nesse formato, basta usar o TextEdit ou o próprio Xcode para abri-lo no Mac.

Em qualquer outro sistema operacional, você poderá abri-lo usando qualquer editor de texto , embora, como esperado, você não o veja no formato Markdown .


4
Na verdade, você o verá no formato Markdown. Você não o verá em negrito, itálico, recuos e blocos de código.
— Lightness Races in Orbit

14

Sim, apenas o Markdown com sabor do GitHub . A inclusão de um arquivo LEIA-ME no seu repositório ajudará outras pessoas a determinar rapidamente do que se trata e como instalá-lo. Muito útil para incluir em seus repositórios.


5
Votado. Por "um" em "incluindo um no seu repositório", você deve significar "um arquivo README em qualquer formato", não apenas "um arquivo README.md". Mas a pergunta é sobre arquivos ".md" em geral, não sobre READMEs em geral. Portanto, essa resposta é irrelevante para a pergunta. Além disso, a ambiguidade com "um" pode fazer o leitor pensar que os READMEs do Markdown são necessariamente melhores do que outros READMEs, o que está errado.
— Rory O'Kane

1
Fiz a alteração especificada no comentário anterior, porque faz sentido e acho que poderia ajudar a evitar confusões. Não acho que seja uma resposta muito boa, pois não acrescenta nada de novo que seja relevante. Esta questão não é sobre o README, é sobre a extensão .md. Não há razão para adicionar essa resposta seis semanas após a resposta aceita fornecer as mesmas informações.
— Erick Robertson


5

Markdown é apenas um arquivo de texto que opcionalmente possui .md, ou.markdown extensões. Pode ser convertido para HTML. Para conhecer a sintaxe do Markdown, confira

Markdown com sabor do GitHub .

Você pode usar qualquer editor de texto para descontos. Se você é sublime textusuário, pode conferir o Markdown Previewplug - in que exibirá o conteúdo da remarcação renderizada no navegador e será atualizado sempre que você alterar o arquivo de remarcação.

Alguns dos editores de descontos online



3

Eu sugiro StackEdit . É um editor WISIWIG simples. Você pode usar a sintaxe do editor e da remarcação. Há uma sintaxe de ajuda rápida de remarcação lá. Desfazer / refazer, comentários, GoogleDrive, interconexão do Dropbox.




2

Se você estiver criando arquivos .md para suas soluções .NET, recomendo a extensão Markdown Editor do Visual Studio 2015 , pois possui um painel de visualização para que você possa ver as alterações em tempo real.

EDIT : agora também deve funcionar com o Visual Studio 2017.


0

A coisa mais fácil, se você não tiver um leitor, é abrir o arquivo MD com um editor de texto e, em seguida, gravar o arquivo MD como um arquivo HTML e clicar duas vezes para visualizá-lo no navegador.


Isso só funcionará se você tiver um plug-in que leia arquivos .md.
— Brad Bruce

0

O .md significa Markdown Text. Basicamente, é apenas outro tipo de arquivo de texto, como .txt

Eu uso o Notepad ++ para ler e editar esses

Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.