Repozytorium zawiera przepisane poradniki na Markdown w celu integracji tego z Gitbook.
Cała dokumentacja zawiera się w folderze docs
.
Na każdy nowy rozdział poradnika przypada nowy branch. Wszelkie zmiany wprowadzane do kodu strony powinny być wykonywane na osobnych branchach w oczekiwaniu na zaakceptowanie pull requestu na master branch.
Istnieje zakaz commitów na mastera. Nie dotyczy to administratorów repozytorium i uzgodnionych wyjątków.
Przed robieniem swoich własnych zmian i tworzeniem commitów ważna jest konfiguracja GITa.
Windows wymaga instalacji GIT ze strony GIT.
macOS wymaga instalacji Command Line Tools:
xcode-select --install
GNU/Linux zawiera w sobie GIT zintegrowany. Można przejść dalej.
Konfigurujemy GIT za pomocą komend:
git config --global user.name "Imię Nazwisko"
git config --global user.email "[email protected]"
Ważne aby Imię Nazwisko
oraz [email protected]
były prawdziwe i zgodne z kontem na repozytorium.
Piszemy w notatniku, który obsługuje GitHub Flavoured Markdown. Czy to Atom, czy Notepad++ - nie ma znaczenia.
Atom jest preferowanym edytorem tekstu. Posiada markdown-preview CTRL+SHIFT+M
.
Ustawienia domyślne programu wystarczą aby fajnie na nim pracować.
Hinty i ostrzeżenia
{% hint style='XXX' %}
...content...
{% endhint %}
Dostępne style XXX
:
info
(domyślne)danger
tip
working
Przypisy
Lorem Ipsum dolor sit amet[^1].
[^1]: Nazwa przypisu
Cytaty
>cytat iks de
cytat iks de
Nagłówki
# Nagłówek 1
## Nagłowek 2
### Nagłówek 3