Articles

Hoe schrijf je een readme.md dossier? (markdown bestand)

by admin

In dit artikel kunt u leren wat een markdown bestand is en hoe u het markdown bestand schrijft. Meestal kun je dit bestand vinden in de remote repository.

Wat is readme.md dossier?

het is een eenvoudig tekstbestand dat de basisinformatie van de bestanden en enkele hulplijnen bevat. Het wordt gebruikt om een installatiehandleiding of basisdocumentatie in de projectdirectory te schrijven. De meest populaire repository providers zoals GitHub, gitlab en bitbucket gebruiken de readme.md bestand als bestandsdescriptor.

Wat is markdown?,

Markdown is een scripttaal die zeer licht van gewicht is. Het wordt gebruikt om platte tekst te formatteren naar een respectievelijke ontwerp. Markdowns worden snel gebruikt in het schrijven van inhoud in sommige blog post websites. Het converteert wat platte tekst naar het gewenste formaat in HTML. De eenvoud en gemakkelijk te begrijpen maakt de markdown populairder. Het neemt alle tekst uit het markdown-bestand en converteert naar HTML via een markdown-app of een compiler.,

Als u een beginner naar markdown bestand dan is dit artikel voor jou. Ik ga een readme.md bestand zodat u een beter begrip van de markdown script zal hebben.

hier gebruik ik visual studio code IDE voor het schrijven van markdown bestand. Hieronder staan de stappen om een markdown-bestand in visual studio-code te maken.,

Stap-1: Open visual studio code en ga naar file > new file

Stap-2: Geef het bestand een naam als readme.md of readme.markdown en sla het bestand op.

Stap-3: Zoek en klik op het ‘open preview to the side’ pictogram.

stap-4: begin met het schrijven van het script.

Headings

Voor het schrijven van headings moet u het hash # – symbool aan het begin van de regel toevoegen., Het aantal van de hash symbool zal verhogen heading type zal veranderen volgens dat.

markdown Headers

u kunt schrijven naar Kop 6.

normale tekst

Als u normale tekst wilt schrijven, schrijf dan hier eenvoudige tekst, U hoeft geen tags toe te voegen die automatisch in tekst worden omgezet.,

u kunt eenvoudige tekst in een markdown-bestand schrijven

hyperlinks

u kunt een hyperlink toevoegen aan een Markdown-bestand met behulp van de onderstaande tag.

(targetURL)

bijv. (https://www.github.com)

U kunt ook een linktitel schrijven (terwijl u met de muis over de link zweeft zal de titel verschijnen)

(targetURL "Link title")

bijv.,div id=”fb7de34b3f”>

opmerking: Zorg ervoor dat een ruimte moet worden tussen hun targetURL en titel)

Sterke en cursief

U kunt het schrijven van sterke en cursief door het toevoegen onderstreept _ vóór en einde van de lijn, voor cursieve tekst toevoegen dubbele ster ** vóór en einde van de lijn voor de sterke/vet gedrukte tekst.,

_Italic text here_

Doorgestreept

Als u wilt staking door middel van een woord of regel voeg vervolgens twee tilde symbool aan het begin en einde van de lijn.,

~~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.,

codeblok

als u een codeblok wilt schrijven, voeg dan “ toe aan het begin en einde van de code.

u kunt uw taal opgeven na de “‘ aan het begin van de regel.,

```Language
your code
```

Lijst

U kunt een geordende lijst, ongeordende lijst, en gemengde lijst. Zie het onderstaande formaat hoe een lijst te schrijven.,”e15c8b1bd4″>