Articles

Wie Schreibe ich eine readme-Datei.md-Datei? (Markdown-Datei)

by admin

In diesem Artikel erfahren Sie, was eine Markdown-Datei ist und wie Sie die Markdown-Datei schreiben. Meistens finden Sie diese Datei im Remote-Repository.

Was ist readme.md datei?

Es ist eine einfache Klartextdatei, die die grundlegenden Informationen der Dateien und einige Anleitungen enthält. Es wird verwendet, um eine Installationsanleitung oder eine grundlegende Dokumentation in das Projektverzeichnis zu schreiben. Die beliebtesten Repository-Anbieter wie GitHub, gitlab und Bitbucket verwenden die readme.md datei als Dateideskriptor.

Was ist markdown?,

Markdown-ist eine Skriptsprache, die sehr leicht ist. Es wird verwendet, um Klartext zu einem jeweiligen Design zu formatieren. Markdowns werden schnell in Content-Writing in einigen Blog-Post-Websites verwendet. Es konvertiert einige Klartext in das gewünschte Format in HTML. Die Einfachheit und leicht zu verstehen macht den Markdown populärer. Es nimmt den gesamten Text aus der Markdown-Datei und konvertiert ihn über eine Markdown-App oder einen Compiler in HTML.,

Wenn Sie Anfänger in der Markdown-Datei sind, ist dieser Artikel genau das Richtige für Sie. Ich werde ein schreiben readme.md datei, damit Sie das Markdown-Skript besser verstehen.

Hier verwende ich Visual Studio Code IDE zum Schreiben von Markdown-Dateien. Unten sind die Schritte zum erstellen einer markdown-Datei in visual studio code.,

Schritt-1: Öffnen Sie Visual studio code und gehen Sie zu file > new file

Schritt-2: Benennen Sie die Datei als readme.md oder readme.markdown und speichern Sie die Datei.

Schritt-3: Suchen und klicken Sie auf das Symbol ‘open preview to the side’.

Schritt-4: Beginnen Sie mit dem Schreiben des Skripts.

Überschriften

Zum Schreiben von Überschriften müssen Sie am Anfang der Zeile das Hash # – Symbol hinzufügen., Die Anzahl des Hash-Symbols erhöht sich und der Typ ändert sich entsprechend.

Markdown-Überschriften

Sie können bis zu Position 6 schreiben.

Normaler Text

Wenn Sie normalen Text schreiben möchten, schreiben Sie hier einfachen Text, Sie müssen keine Tags hinzufügen, die automatisch in Text konvertiert werden.,

Sie können einfachen Text in eine Markdown-Datei schreiben

Hyperlinks

Mit dem folgenden Tag können Sie einen Hyperlink in eine Markdown-Datei einfügen.

(targetURL)

z. B. (https://www.github.com)

Sie können auch den Linktitel schreiben (während Sie mit der Maus über den Link fahren, wird der Titel angezeigt)

(targetURL "Link title")

z.,div id=“fd7de34b3f“>

Hinweis: Stellen Sie sicher, dass zwischen targetURL und title ein einzelnes Leerzeichen vorhanden sein sollte)

Starker und kursiver Text

Sie können starken und kursiven Text schreiben, indem Sie Unterstriche anhängen _ vor und am Ende der Zeile, für kursiven Text Doppelstern hinzufügen ** vor und am Ende der Zeile für starken/fetten Text.,

_Italic text here_

Durchgestrichen

Wenn Sie wollen zu schlagen durch ein Wort oder eine Zeile, dann fügen Sie zwei tilde-symbol am Anfang und am Ende der Linie.,

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

Codeblock

Wenn Sie einen Block schreiben möchten, des Codes fügen Sie dann „ am Anfang und Ende des Codes hinzu.

Sie können Ihre Sprache nach dem „ am Anfang der Zeile angeben.,

```Language
your code
```

Liste

Sie können eine geordnete Liste, eine ungeordnete Liste und eine gemischte Liste schreiben. Bitte beachten Sie das folgende Format, wie Sie eine Liste schreiben.,“e15c8b1bd4″>