2024-02-14
W pliku README.md w Bitbucket możesz używać języka Markdown do formatowania tekstu. Oto przykład:
Markdown Toolbox
# Tytuł projektu
Krótki opis tego, co robi ten projekt i dla kogo jest przeznaczony.
## Instalacja
```bash
npm install my-project
import my_project
my_project.start()
Markdown to lekki język znaczników z prostą składnią formatowania tekstu, który można przekształcić w HTML. Jest powszechnie używany w plikach README w repozytoriach na Bitbucket.
Markdown pozwala na pisanie w formacie tekstowym, który jest łatwy do odczytania i napisania, a następnie konwertowany na strukturalnie poprawny HTML. Oto szybki przewodnik po podstawach:
# dla nagłówka, ## dla nagłówka drugiego poziomu itp.*kursywa* lub _kursywa_ dla kursywy, **pogrubienie** lub __pogrubienie__ dla pogrubienia.*, +, i -) zamiennie jako znaczników listy. Uporządkowane listy używają numerów.[tekst linku](http://url), aby utworzyć link.I wiele więcej. Aby uzyskać szczegółową składnię, odwiedź Przewodnik po Markdownie.
Używanie Markdown w plikach README w Bitbucket sprawi, że będą one bardziej czytelne i informacyjne. Pamiętaj, że skuteczna dokumentacja może znacząco wpłynąć na użyteczność i przyjęcie twojego projektu.