Come scrivere un readme.md file? (file markdown)
In questo articolo, puoi imparare cos’è un file markdown e come scrivere il file markdown. La maggior parte delle volte è possibile trovare questo file nel repository remoto.
Che cosa è readme.md file?
Si tratta di un semplice file di testo che contiene le informazioni di base dei file e alcune guide. Viene utilizzato per scrivere alcune guide di installazione o documentazione di base all’interno della directory del progetto. I provider di repository più popolari come GitHub, gitlab e bitbucket utilizzano readme.md file come descrittore di file.
Che cos’è markdown?,
Markdown è un linguaggio di scripting che è molto leggero. Viene utilizzato per formattare il testo normale in un rispettivo disegno. Markdowns sono rapidamente utilizzati nella scrittura di contenuti in alcuni siti web post del blog. Converte un po ‘ di testo normale nel formato desiderato in HTML. La semplicità e facile da capire sta facendo il markdown più popolare. Prende tutto il testo dal file markdown e converte in HTML attraverso un’app markdown o un compilatore.,
Se sei un principiante al file markdown, allora questo articolo è per voi. Ho intenzione di scrivere un readme.md file in modo da avere una migliore comprensione dello script markdown.
Qui sto usando il codice IDE di Visual studio per scrivere il file markdown. Di seguito sono riportati i passaggi per creare un file markdown nel codice di Visual studio.,
Passo-1: Apri il codice di visual studio e vai a file > new file
Passo-2: assegna un nome al file comereadme.mdoreadme.markdown e salva il file.
Step-3: Trova e fai clic sull’icona‘open preview to the side’.
Passo 4: Avviare la scrittura di script.
Intestazioni
Per scrivere intestazioni, devi aggiungere il simbolo hash # all’inizio della riga., Il numero del simbolo hash aumenterà il tipo di intestazione cambierà in base a quello.
È possibile scrivere fino a Rubrica 6.
Testo normale
Se si desidera scrivere testo normale quindi scrivere testo semplice qui, non c’è bisogno di aggiungere alcun tag che convertirà automaticamente in testo.,
collegamenti Ipertestuali
È possibile aggiungere un collegamento ipertestuale a un file markdown utilizzando il seguente tag.
(targetURL)
ad esempio (https://www.github.com)
È anche possibile scrivere il titolo del collegamento (mentre si passa il mouse sopra il collegamento apparirà il titolo)
(targetURL "Link title")
ad esempio,div id=”fb7de34b3f”>
nota: assicurarsi che un singolo spazio deve essere loro tra targetURL e titolo)
Forte e testo in corsivo
È possibile scrivere testo corsivo e aggiungendo sottolinea _ prima e la fine della linea, per il testo in corsivo aggiungere stella doppia ** prima e la fine della linea per la forte/il testo in grassetto.,
_Italic text here_
Barrato
Se si vuole colpire attraverso una parola o una riga, aggiungere due simbolo tilde all’inizio e alla fine della riga.,
~~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.,
Codice blocco
Se si desidera scrivere un blocco di codice per poi aggiungere “ a iniziale e finale del codice.
Puoi specificare la tua lingua dopo “ all’inizio della riga.,
```Language
your code
```
Elenco
È possibile scrivere un elenco ordinato, lista non ordinata, e la lista mista. Si prega di vedere il seguente formato come scrivere una 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.,
