como escrever um readme.md ficheiro? (ficheiro markdown)
neste artigo, pode aprender o que é um ficheiro markdown e como escrever o ficheiro markdown. Na maioria das vezes você pode encontrar este arquivo no repositório remoto.
o que é readme.md ficheiro?
é um arquivo de texto simples que contém as informações básicas dos arquivos e alguns guias. É usado para escrever algum guia de instalação ou documentação básica dentro do diretório do projeto. A maioria dos provedores de repositórios populares como o GitHub, o gitlab e o bitbucket estão usando o readme.md ficheiro como descritor de ficheiro.
o que é o markdown?,
Markdown é uma linguagem de script que é muito leve. É usado para formatar texto simples para um respectivo Desenho. Os “Markdowns” são rapidamente usados na escrita de conteúdo em alguns sites de posts do blog. Ele converte algum texto simples para o formato desejado em HTML. A simplicidade e fácil de entender está tornando o markdown mais popular. Ele pega todo o texto do arquivo markdown e converte para HTML através de um aplicativo markdown ou um compilador.,
Se você é um novato para markdown arquivo, então este artigo é para você. Vou escrever um readme.md arquivo para que você tenha uma melhor compreensão do script markdown.
aqui estou a usar o visual studio code IDE para escrever o ficheiro markdown. Abaixo estão os passos para criar um arquivo markdown em código Visual studio.,
Step-1: Open visual studio code and goto file > new file
Step-2: Name the file as readme.mdorreadme.markdowne save the file.
Step-3: encontre e clique no ícone ‘open preview to the side’.
Passo 4: Comece a escrever o script.
cabeçalhos
para escrever cabeçalhos, você tem que adicionar símbolo de hash # no início da linha., O número do símbolo de hash irá aumentar o tipo de cabeçalho irá mudar de acordo com isso.
Você pode escrever até o Título 6.
Texto Normal
Se quiser escrever texto normal, então escreva texto simples aqui, sem necessidade de adicionar quaisquer marcas que irá converter automaticamente em texto.,
Hiperlinks
Você pode adicionar um hiperlink em um markdown arquivo usando o abaixo tag.
(targetURL)
exemplo: (https://www.github.com)
Você também pode escrever título do link (Ao passar o mouse sobre o link, o título será apresentado)
(targetURL "Link title")
por exemplo,div id=”fb7de34b3f”>
nota: certifique-se de que um único espaço deve ser o seu, entre targetURL e título)
Forte e texto em itálico
Você pode escrever forte o texto em itálico e acrescentando ressalta _ antes e o fim da linha, para texto em itálico adicionar estrela dupla ** antes e o fim da linha para o forte/texto em negrito.,
_Italic text here_
Tachado
Se você deseja atacar por meio de uma palavra ou de uma linha, em seguida, adicione dois símbolo de til no início e no final da linha.,
~~Strikethrough text~~
Images
You can add images in a markdown file by using the below tag.
!(TargetUrl)
Tables
You can write a table by using the below format of text.,
Quotes
If you want to write quotes the just add a > symbol at the beginning of the line.
>Your quote looks like this.
Code
You can write code by appending ` symbol at the beginning and end of the line.,
bloco de Código
Se você quiser escrever um bloco de código, em seguida, adicionar “ no início e fim do código.
pode especificar a sua língua a seguir ao “‘ no início da linha.,
```Language
your code
```
Lista
Você pode escrever uma lista ordenada, lista não ordenada, e um misto de lista. Por favor, veja o formato abaixo como escrever uma lista.,”e15c8b1bd4″>
Horizontal line
If you want to add a horizontal line in the markdown file then simply add --- or ***
Note:
***is for thicker line.,
