Wiki

Każde repozytorium może hostować wiki — osobny zbiór stron Markdown z dokumentacją, która znajduje się obok kodu, nie mieszając się z nim.

Włączanie wiki

Otwórz repozytorium i wybierz Ustawienia.
W sekcji Cechy włącz Wiki.
W nawigacji repozytorium pojawi się karta Wiki.

Tworzenie i edytowanie stron

Wybierz kartę Wiki.
Jeśli wiki nie ma jeszcze stron, wybierz Create the First Page. W przeciwnym razie wybierz New Page.
Wpisz tytuł strony. Tytuł staje się adresem URL strony, więc wybierz coś jasnego i stałego.
Napisz treść w Markdown, a następnie wybierz Save Page.

Pierwsza utworzona strona staje się Stroną główną wiki — stroną, na którą odwiedzający trafiają domyślnie. Aby zaktualizować istniejącą stronę, otwórz ją i wybierz Edytuj. Każdy zapis dodaje nowy wpis do historii wersji strony.

Organizowanie wiki

Dwie strony o specjalnych nazwach sterują nawigacją w całym wiki:

_Sidebar — niestandardowy pasek boczny wyświetlany na każdej stronie. Dodaj tutaj łącza do najważniejszych stron.
_Footer — stopka wyświetlana na dole każdej strony.

Utwórz dowolną z nich za pomocą New Page, używając dokładnie podanej powyżej nazwy. Łącz strony wiki za pomocą standardowego Markdown, odwołując się do identyfikatora strony:

See the [Setup Guide](setup-guide) for installation steps.

Od początku używaj opisowych tytułów stron: tytuł staje się adresem URL, a późniejsza zmiana nazwy strony zrywa wszystkie istniejące do niej łącza.

Edytowanie wiki lokalnie

Wiki samo jest repozytorium Git, dostępnym pod adresem URL .wiki.git Twojego repozytorium. Sklonuj je, edytuj pliki Markdown w swoim edytorze i wypchnij zmiany z powrotem.

git clone https://git.example.plaidcloud.com/you/my-repo.wiki.git
cd my-repo.wiki
# edit or add .md files
git add .
git commit -m "Expand the setup guide"
git push

Działa tu ten sam osobisty token dostępu, którego używasz dla głównego repozytorium. Każdy plik Markdown staje się stroną wiki; nazwa pliku (bez rozszerzenia .md) jest identyfikatorem strony.