hur man skriver en readme.md arkiv? (markdown file)
i den här artikeln kan du lära dig vad som är en markdown-fil och hur man skriver markdown-filen. De flesta gånger kan du hitta den här filen i fjärrförvaret.
Vad är readme.md arkiv?
det är en enkel oformaterad textfil som innehåller grundläggande information om filerna och vissa guider. Det används för att skriva någon installationsguide eller grundläggande dokumentation i projektkatalogen. Mest populära repository leverantörer som GitHub, gitlab och bitbucket använder readme.md fil som en fil deskriptor.
Vad är markdown?,
Markdown är ett skriptspråk som är mycket lätt. Det används för att formatera oformaterad text till en respektive design. Markdowns används snabbt i innehåll skriva i vissa blogginlägg webbplatser. Den konverterar lite oformaterad text till önskat format i HTML. Enkelheten och lätt att förstå gör markdown mer populär. Det tar all text från markdown-filen och konverterar till HTML via en markdown-app eller en kompilator.,
om du är nybörjare till markdown-fil så är den här artikeln för dig. Jag kommer att skriva en readme.md fil så att du kommer att ha en bättre förståelse för markdown script.
här använder jag visual studio code IDE för att skriva markdown-fil. Nedan är stegen för att skapa en markdown-fil i visual studio-kod.,
Steg-1: Öppna visual studio code och gotofile > new file
steg-2: namnge filen somreadme.md ellerreadme.markdown och spara filen.
steg-3: Hitta och klicka på ikonen‘open preview to the side’.
steg-4: Börja skriva skriptet.
rubriker
för att skriva rubriker måste du lägga till hash # – symbol i början av raden., Numret på hash-symbolen kommer att öka rubriktypen ändras enligt det.
Du kan skriva upp till rubrik 6.
Normal text
om du vill skriva normal text sedan skriva enkel text här, inget behov av att lägga till några taggar det automatiskt konvertera till text.,
hyperlänkar
Du kan lägga till en hyperlänk i en markdown-fil med hjälp av nedanstående tagg.
(targetURL)
t. ex.(https://www.github.com)
Du kan också skriva länktitel (medan du svävar över länken visas titeln)
(targetURL "Link title")
t. ex.,div id=”fb7de34b3f”>
notera: se till att ett enda utrymme ska vara mellan targeturl och titel)
stark och kursiv text
Du kan skriva stark och kursiv text genom att lägga till understreck_före och slutet av raden, för kursiv text Lägg till dubbelstjärna
= ”475421d29c” >
före och slutet av raden för stark / fet text.,
_Italic text here_
genomslag
om du vill slå igenom ett ord eller en rad, lägg sedan till två Tilde-symbol i början och slutet av raden.,
~~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.,
kodblock
skriv ett block av kod och lägg sedan till ` ” vid start och slut av koden.
Du kan ange ditt språk efter ” i början av raden.,
```Language
your code
```
lista
Du kan skriva en ordnad lista, oordnad lista och blandad lista. Se nedan format hur man skriver en 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.,
