hvordan man skriver en readme.md fil? (markdown-fil)
I denne artikel kan du lære, hvad der er en markdown-fil og hvordan man skriver markdown-fil. De fleste gange kan du finde denne fil i fjernarkivet.
hvad er readme.md fil?
det er en simpel almindelig tekstfil, der indeholder de grundlæggende oplysninger om filerne og nogle guider. Det bruges til at skrive nogle installationsvejledning eller grundlæggende dokumentation inde i projektmappen. Mest populære repository udbydere som GitHub, gitlab og bitbucket bruger readme.md-fil som en fil-descriptor.
Hvad er markdo ?n?,
Markdown er et scripting sprog, der er meget let. Det bruges til at formatere almindelig tekst til et respektive design. Markdo .ns bruges hurtigt i indholdsskrivning på nogle blogindlægs webebsteder. Det konverterer nogle almindelig tekst til det ønskede format i HTML. Enkelheden og let at forstå gør markdo .n mere populær. Det tager al teksten fra markdo .n-filen og konverterer til HTML gennem en markdo .n-app eller en compiler.,
Hvis du er en nybegynder til markdown-fil og derefter er denne artikel for dig. Jeg vil skrive en readme.md fil, så du får en bedre forståelse af markdo .n script.
Her bruger jeg visual studio code IDE til at skrive markdo .n-fil. Nedenfor er trinnene til at oprette en markdo .n-fil i visual studio code.,
Trin 1: Åbn visual studio kode og goto file > new file
Trin 2: Navn på den fil som readme.md eller readme.markdown og gem filen.
Trin-3: Find og klik på ‘open preview to the side’ ikonet.
Trin 4: Begynd at skrive manuskriptet.
overskrifter
for at skrive overskrifter skal du tilføje hash # symbol i begyndelsen af linjen., Antallet af hash symbol vil øge overskrift type vil ændre sig i henhold til, at.
Du kan skrive op til punkt 6.
Normal tekst
Hvis du vil skrive normal tekst, så skriv simpel tekst her, ingen grund til at tilføje nogen tags, det vil automatisk konvertere til tekst.,
Links
Du kan tilføje et hyperlink i en markdown-fil ved hjælp af nedenstående kode.
(targetURL)
fx (https://www.github.com)
Du kan også skrive en link titel (Mens du holder markøren over linket titlen vises)
(targetURL "Link title")
fx,div id=”fb7de34b3f”>
bemærk: sørg for, at en enkelt plads der skal være deres mellem targetURL og titel)
Stærk og kursiv tekst
Du kan skrive stærk og kursiv tekst ved at tilføje understreger _ før og slutningen af den linje, for kursiv tilføje double star ** før og slutter af linjen for stærk/fed tekst.,
_Italic text here_
fed skrift
Hvis du ønsker at skabe gennem et ord eller en linje, så add to tilde symbol på begyndelsen og slutningen af den linje.,
~~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.,
– Kode blok
Hvis du ønsker at skrive en blok af kode, så tilføj ` ” til start og afslutning af koden.
Du kan angive dit sprog efter “ ved starten af linjen.,
```Language
your code
```
Liste
Du kan skrive en ordnet liste, uordnet liste, og blandet liste. Se venligst nedenstående format, hvordan man skriver en liste.,”e15c8b1bd4″>
Horizontal line
If you want to add a horizontal line in the markdown file then simply add --- or ***
Note:
***is for thicker line.,
