jak napsat readme.md spis? (markdown file)
v tomto článku se můžete dozvědět, co je soubor markdown a jak napsat soubor markdown. Většinu času najdete tento soubor ve vzdáleném úložišti.
co je readme.md spis?
jedná se o jednoduchý textový soubor, který obsahuje základní informace o souborech a některých průvodcích. Používá se k zápisu nějaké instalační příručky nebo základní dokumentace do adresáře projektu. Nejoblíbenější poskytovatelé úložiště jako GitHub, gitlab a bitbucket používají readme.md soubor jako deskriptor souboru.
co je markdown?,
Markdown je skriptovací jazyk, který je velmi lehký. Používá se k formátování prostého textu do příslušného návrhu. Markdowns se rychle používají při psaní obsahu na některých webových stránkách blogu. Převádí nějaký prostý text do požadovaného formátu v HTML. Jednoduchost a snadno pochopitelné dělá markdown více populární. Vezme veškerý text ze souboru markdown a převede se na HTML prostřednictvím aplikace markdown nebo kompilátoru.,
Pokud jste začátečník, aby markdown soubor a pak tento článek je pro vás. Chystám se napsat readme.md soubor tak, že budete mít lepší pochopení Markdown skriptu.
zde používám Visual Studio code IDE pro psaní markdown souboru. Níže jsou uvedeny kroky k vytvoření souboru markdown v kódu visual studio.,
Krok 1: Otevřete aplikaci visual studio kód a přejít na file > new file
Krok 2: Název souboru jako readme.md nebo readme.markdown a uložte soubor.
Krok-3: Najděte a klikněte na ikonu ‘open preview to the side’.
Krok 4: Začněte psát scénář.
nadpisy
pro psaní nadpisů musíte na začátku řádku přidat symbol hash#., Číslo symbolu hash se zvýší typ záhlaví se změní podle toho.
Můžete napsat až k Číslu 6.
normální text
Pokud chcete napsat normální text, napište zde jednoduchý text, není třeba přidávat žádné značky, které automaticky převede na text.,
Odkazy
můžete přidat hypertextový odkaz v markdown souborů pomocí níže uvedených značek.
(targetURL)
např. (https://www.github.com)
můžete také napsat název odkazu (Při vznášející se nad odkaz na název se objeví)
(targetURL "Link title")
např.,div id=“fb7de34b3f“>
poznámka: ujistěte Se, že jeden prostor by měl být jejich mezi targetURL a název)
Silné a italic text
můžete napsat silný a italic text přidáním podtržítka _ před a konec řádku, pro italic text přidat double star ** před a končící linky pro silné/bold text.,
_Italic text here_
Přeškrtnuté
Pokud chcete přeškrtnout slovo nebo řádku, pak přidejte dvě vlnovky symbol na začátku a na konci linky.,
~~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.,
blok Kódu
Pokud chcete napsat blok kódu, pak přidat ` na zahájení a ukončení kódu.
můžete zadat svůj jazyk za „‚ na začátku řádku.,
```Language
your code
```
Seznam
můžete napsat výčet, výčtu, a smíšené seznamu. Viz níže uvedený formát, jak napsat seznam.,“e15c8b1bd4″>
Horizontal line
If you want to add a horizontal line in the markdown file then simply add --- or ***
Note:
***is for thicker line.,
