Jak napisać a readme.md akta? (plik markdown)
w tym artykule dowiesz się, co to jest plik markdown i jak zapisać plik markdown. Najczęściej można znaleźć ten plik w zdalnym repozytorium.
Co to jest readme.md akta?
jest to prosty plik tekstowy, który zawiera podstawowe informacje o plikach i niektórych przewodnikach. Jest on używany do napisania przewodnika instalacji lub podstawowej dokumentacji wewnątrz katalogu projektu. Większość popularnych dostawców repozytoriów, takich jak GitHub, gitlab i bitbucket, korzysta z readme.md plik jako deskryptor pliku.
Co to jest markdown?,
Markdown jest bardzo lekkim językiem skryptowym. Jest on używany do formatowania zwykłego tekstu do odpowiedniego projektu. Znaczniki są szybko używane w pisaniu treści w niektórych witrynach internetowych blogów. Konwertuje jakiś zwykły tekst do żądanego formatu w HTML. Prostota i łatwość zrozumienia sprawia, że markdown jest bardziej popularny. Pobiera cały tekst z pliku markdown i konwertuje do HTML za pośrednictwem aplikacji markdown lub kompilatora.,
Jeśli jesteś początkującym do Markdown pliku następnie ten artykuł jest dla ciebie. Zamierzam napisać readme.md plik tak, że będziesz miał lepsze zrozumienie skryptu markdown.
tutaj używam visual studio code IDE do zapisu pliku markdown. Poniżej znajdują się kroki, aby utworzyć plik markdown w programie visual studio code.,
Krok-1: Otwórz visual studio code i przejdź do file > new file
Krok-2: Nazwij plik jako readme.md lub readme.markdown i zapisz plik.
Krok 3: Znajdź i kliknij ikonę ‘open preview to the side’.
krok-4: Zacznij pisać skrypt.
nagłówki
aby pisać nagłówki, musisz dodać symbol hash # na początku wiersza., Liczba symbolu skrótu zwiększy typ nagłówka zmieni się zgodnie z tym.
/figcaption>
możesz pisać do pozycji 6.
normalny tekst
Jeśli chcesz napisać normalny tekst, napisz prosty tekst tutaj, nie trzeba dodawać żadnych tagów, automatycznie przekonwertuje na tekst.,
hiperłącza
możesz dodać hiperłącze do pliku MARKDOWN za pomocą poniższego znacznika.
(targetURL)
np. (https://www.github.com)
Możesz również wpisać tytuł linku (podczas kursora nad linkiem pojawi się Tytuł)
(targetURL "Link title")
np.,div id=”fb7de34b3f”>
uwaga: upewnij się, że jedna spacja powinna być ich między targeturl a title)
mocny i kursywny tekst
możesz pisać silny i kursywny tekst dodając podkreślniki_przed i końcem linii, dla tekstu kursywą dodaj podwójną gwiazdkę ** przed i końcem linii dla silnego/pogrubionego tekstu.,
_Italic text here_
przekreślając słowo lub linię, dodaj dwa symbole tyldy na początku i końcu linii.,
~~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 kodu
jeśli chcesz napisać blok kodu, dodaj „ na początku i końcu kodu.
możesz określić swój język PO „ na początku wiersza.,
```Language
your code
```
lista
możesz napisać listę uporządkowaną, listę nieuporządkowaną i listę mieszaną. Zobacz poniższy format jak napisać listę.,”e15c8b1bd4″>
