miten kirjoittaa readme.md tiedosto? (markdown-tiedosto)
tässä artikkelissa, voit oppia, mitä on markdown-tiedosto ja miten kirjoittaa markdown-tiedostoon. Useimmiten löydät tämän tiedoston etäarkistosta.
mitä on readme.md tiedosto?
se on yksinkertainen tavallinen tekstitiedosto, joka sisältää tiedostojen perustietoja ja joitakin oppaita. Sitä käytetään jonkin asennusoppaan tai perusdokumentaation kirjoittamiseen projektihakemistoon. Suosituin repository tarjoajat, kuten GitHub, gitlab ja bitbucket on käyttää readme.md-tiedosto kuin tiedosto avainsana.
mikä on markdown?,
Markdown on scripting kieli, joka on erittäin kevyt. Sitä käytetään muotoilemaan tavallinen teksti vastaavaan muotoiluun. Markdowneja käytetään nopeasti sisällöntuotannossa joissakin blogikirjoitussivustoissa. Se muuntaa jonkin tavallisen tekstin haluttuun muotoon HTML: ssä. Yksinkertaisuus ja helppo ymmärtää tekee markdown suositummaksi. Se vie kaiken tekstin markdown-tiedostosta ja muuntaa HTML: ksi markdown-sovelluksen tai kääntäjän kautta.,
Jos olet aloittelija markdown-tiedoston, sitten tämä artikkeli on sinua varten. Aion kirjoittaa readme.md-tiedosto, niin että sinulla on parempi käsitys markdown script.
Here I am using visual studio code IDE for writing markdown file. Alla on vaiheet luoda markdown tiedosto visual studio koodi.,
Askel 1: Avaa visual studio koodi ja goto file > new file
Vaihe 2: Nimeä tiedosto nimellä readme.md tai readme.markdown ja tallenna tiedosto.
Vaihe-3: Etsi ja klikkaa ‘open preview to the side’ – kuvaketta.
Vaihe 4: Alkaa kirjoittaa käsikirjoituksen.
otsikot
otsikoiden kirjoittamiseen pitää lisätä hash # – symboli rivin alkuun., Hash-symbolin määrä kasvaa otsakkeen Tyyppi muuttuu sen mukaan.
Voit kirjoittaa enintään Menossa 6.
Normaali teksti
Jos haluat kirjoittaa normaalia tekstiä sitten kirjoittaa yksinkertaista tekstiä täällä, ei tarvitse lisätä mitään tunnisteita, se automaattisesti muuntaa tekstiä.,
Linkit
Voit lisätä hyperlinkin markdown tiedosto käyttämällä alla tag.
(targetURL)
esim. (https://www.github.com)
Voit myös kirjoittaa linkin otsikko (Kun leijuu linkin otsikko tulee näkyviin)
(targetURL "Link title")
esim.,div id=”fb7de34b3f”>
huomautus: varmista, että yhtenäinen tila olisi niiden välillä targetURL ja otsikko)
Vahva ja kursivoitu teksti
Voit kirjoittaa vahva ja kursivoitu teksti korostaa liittämällä _ ennen ja päättyy linja, sillä kursivoitu teksti lisätä double star ** ennen ja päättyy linjan vahva/rohkea teksti.,
_Italic text here_
Yliviivattu
Jos haluat lakko kautta sana tai rivi lisää sitten kaksi tilde symboli alussa ja lopussa linjan.,
~~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.,
Koodi lohko
Jos haluat kirjoittaa lohko koodia, lisää sitten ” milloin alkaa ja päättyy koodi.
voit määrittää kielesi rivin ”’ alussa.,
```Language
your code
```
Listan
Voit kirjoittaa järjestetty lista, järjestämätön lista, ja mixed-luettelosta. Katso alla olevasta formaatista, miten lista kirjoitetaan.,”e15c8b1bd4″>
Horizontal line
If you want to add a horizontal line in the markdown file then simply add --- or ***
Note:
***is for thicker line.,
