Hvordan å skrive en readme fil.md-fil? (markdown-fil)
I denne artikkelen, kan du lære hva som er en markdown-fil og hvordan å skrive den markdown-fil. Mesteparten av tiden du kan finne denne filen i den eksterne depot.
Hva er viktig.md-fil?
Det er en enkel tekstfil som inneholder grunnleggende informasjon om filer og noen guider. Den brukes til å skrive noen installasjonsveiledning eller grunnleggende dokumentasjon inne i prosjektet katalogen. Mest populære depotet tilbydere som GitHub, gitlab og bitbucket bruker readme.md-fil som en fil beskrivelse.
Hva er markdown?,
Markdown er et skriptspråk som er veldig lett. Den brukes til å format ren tekst til et respektive design. Markdowns er raskt som brukes i innhold å skrive noen blogginnlegg nettsteder. Den konverterer noen ren tekst til ønsket format i HTML. Det enkle og lett å forstå gjør det markdown mer populære. Det tar all tekst fra markdown filen og konverterer til HTML gjennom en markdown app eller en kompilator.,
Hvis du er en nybegynner i markdown-filen så er dette artikkelen for deg. Jeg kommer til å skrive en readme fil.md-fil, slik at du vil ha en bedre forståelse av markdown-skript.
Her er jeg ved hjelp av visual studio-kode IDE for å skrive markdown-fil. Nedenfor er fremgangsmåten for å opprette en markdown fil i visual studio kode.,
Trinn 1: Åpne visual studio-koden og goto file > new file
Trinn 2: gi filen et Navn som readme.md eller readme.markdown og lagre filen.
Trinn 3: Finn og klikk ‘open preview to the side’ ikonet.
Trinn 4: Start å skrive manuset.
Overskrifter
For å skrive overskrifter, må du legge til hash # symbol på begynnelsen av linjen., Antall hash-symbolet vil øke overskriften type vil endres i henhold til det.
Du kan skrive opp til Overskrift 6.
tekst
Hvis du ønsker å skrive vanlig tekst, og deretter skrive enkel tekst her, ikke trenger å legge til tagger, vil den automatisk konvertere til tekst.,
Lenker
Du kan legge til en hyperkobling i en markdown-filen ved å bruke koden nedenfor.
(targetURL)
eksempel (https://www.github.com)
Du kan også skrive link tittel (Mens du holder markøren over lenken tittelen vil vises)
(targetURL "Link title")
f.eks.,div id=»fb7de34b3f»>
merk: sørg for at et enkelt mellomrom bør være mellom targetURL og tittel)
Sterk og kursiv tekst
Du kan skrive sterk og kursiv tekst ved å legge understreker _ før og slutten av linjen, for kursiv tekst legg til dobbel stjerners ** før og slutter på linjen for sterk/fet tekst.,
_Italic text here_
Gjennomstreking
Hvis du ønsker å oppnå gjennom et ord eller en linje og deretter add to tilde symbol på begynnelsen og slutten av linjen.,
~~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.,
– Koden blokk
Hvis du vil skrive inn en blokk med kode og legg deretter til « på start-og slutt av koden.
Du kan angi språket ditt etter ` » i starten av linjen.,
```Language
your code
```
Liste
Du kan skrive en sortert liste, liste i tilfeldig rekkefølge, og blandet listen. Vennligst se nedenfor format hvordan å skrive 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.,
