GitBook to platforma, która pozwala Tobie i Twojemu zespołowi tworzyć i współpracować w witrynach z dokumentacją. GitBook robi to za pomocą koncepcji kontroli wersji, takich jak rozgałęzianie i scalanie.
Ponieważ wielu członków zespołu może pracować na jednej witrynie z dokumentacją, GitBook umożliwia tworzenie i zarządzanie oddzielnymi wersjami roboczymi. Możesz również wyświetlić różnice między bieżącą wersją roboczą a główną kopią dokumentacji.
Dostępnych jest kilka rodzajów bloków, które możesz dodać do swoich stron wiki. Obejmuje to nagłówki, akapity, obrazy, wskazówki, tabele, bloki kodu, załączniki plików i inne.
Jak dodawać bloki treści w GitBooku
Możesz wyświetlić listę dostępnych bloków treści, które można dodać do strony. Możesz to zrobić, klikając w dowolnym miejscu na stronie i klikając plus symbol, który się pojawi. Możesz także bezpośrednio wyszukać określony blok treści.
Możesz dodać zawartość za pomocą Markdown. Jeśli nie korzystałeś wcześniej z Markdown, możesz dowiedzieć się więcej o
jak zacząć korzystać z Markdown. Możesz również przeczytać więcej o dlaczego Markdown jest tak popularny.Jak dodawać akapity, listy, cytaty lub bloki kodu?
Aby dodać listy, akapity, cytaty, bloki kodu lub inne proste bloki treści, otwórz menu rozwijane i wybierz spośród dostępnych typów.
- Na stronie w witrynie z dokumentacją kliknij plus w miejscu, w którym chcesz dodać swoją treść.
- Z listy rozwijanej możesz przewijać listę, aby wyświetlić różne opcje zawartości.
- W tym miejscu wybierz dowolny prosty typ zawartości, taki jak akapit, blok kodu, nagłówek lub cytat. GitBook automatycznie zmieni zawartość, aby pasowała do wybranego formatu.
Jak dodać obrazy lub załączniki do plików
Aby dodać obrazy, użyj menu rozwijanego, aby wybrać Obrazy opcja blokowania treści. Aby dodać pliki, wybierz Wstaw pliki zamiast tego opcja. Następnie możesz użyć panelu po prawej stronie, aby zarządzać przesłanymi obrazami i plikami.
- Otwórz stronę w swojej witrynie z dokumentacją. Kliknij na plus przycisk, aby otworzyć listę dostępnych bloków treści.
- Wybierz Wstaw obrazy.
- W prawym panelu, który się pojawi, znajdują się trzy zakładki. The Akta zakładka umożliwia wgranie własnego pliku graficznego. The URL zakładka pozwala na link do obrazu online. Możesz także otworzyć Unsplash patka. Tutaj możesz wybrać istniejące zdjęcia, które nie wymagają atrybucji.
- Po dodaniu obrazu kliknij trzy kropki przycisk znajdujący się w lewym górnym rogu obrazu. Spowoduje to otwarcie listy rozwijanej, w której możesz wyrównać obraz lub go usunąć. Możesz również nadać obrazowi podpis.
- Aby wstawić pliki, umieść kursor w dowolnym miejscu na stronie w witrynie dokumentacji. Kliknij na plus przycisk, aby otworzyć listę rozwijaną typów bloków treści. Tym razem kliknij na wstaw pliki opcja.
- Pojawi się podobny panel po prawej stronie, umożliwiający przesłanie dowolnego załącznika zamiast obrazu. Kliknij Przeglądaj pliki aby wybrać plik przechowywany lokalnie na komputerze.
- Plik pojawi się na liście. Kliknij plik, a GitBook utworzy blok treści z załącznikiem pliku na otwartej stronie. Kliknięcie tego bloku treści spowoduje pobranie pliku załącznika.
Jak dodawać wskazówki
Możesz także dodać podpowiedzi do swojej strony. Możesz zmienić ikonę podpowiedzi na kolor czerwony dla niebezpieczeństwa, pomarańczowy dla ostrzeżenia, niebieski dla informacji lub zielony dla sukcesu.
- Aby dodać podpowiedź, kliknij plus przycisk, aby otworzyć listę dostępnych bloków treści.
- Wybierz Wskazówka.
- To doda wskazówkę do Twojej strony. Domyślnie typem wskazówki jest „informacja” i zawiera niebieską ikonę.
- Możesz zmienić typ podpowiedzi, klikając ikonę. Spowoduje to przejście przez cztery różne typy wskazówek.
Jak dodawać tabele
Możesz dodać tabele, wybierając stół opcja z listy rozwijanej. Po umieszczeniu tabeli na stronie możesz dodać nowe wiersze lub kolumny. Możesz także modyfikować nazwy i typy danych kolumn oraz zmieniać dane w tabeli.
- Kliknij na plus przycisk, aby otworzyć listę dostępnych bloków treści.
- Wybierz Stół.
- Kliknij na nagłówek kolumny w tabeli. Spowoduje to otwarcie nowego mniejszego menu, w którym możesz zmienić nazwę wybranej kolumny. To menu pozwala również usunąć lub ukryć wybraną kolumnę. W przypadku niektórych typów danych kolumn można również wyrównać zawartość wewnątrz kolumny.
- Domyślnie wybrany typ danych dla kolumn to „Tekst”. Kliknij przycisk z T symbol, aby zmienić typ danych. Możesz zmienić go na numer, pole wyboru, listę rozwijaną, załącznik do pliku, ocenę lub więcej.
- Kliknij na ikona sześciu kropek w lewym górnym rogu stołu. Tutaj możesz wstawić nowe kolumny i wiersze lub usunąć całą tabelę. Możesz także ukryć lub pokazać niektóre kolumny lub zmienić inne właściwości tabeli.
Jak dodać bloki linków do stron
Bloki linków do stron to linki, które zajmują całą linię na stronie. Kiedy dodasz link, musisz połączyć się ze stroną, która otworzy się, gdy ktoś na nią kliknie.
- Kliknij na plus przycisk, aby otworzyć listę dostępnych bloków treści.
- Kliknij link do strony.
- Z nowego menu wybierz stronę, do której prowadzisz link.
- Link do Twojej strony pojawi się w bloku na stronie.
Używanie GitBooka do dokumentacji
GitBook to narzędzie do dokumentacji, które wykorzystuje koncepcje kontroli wersji, takie jak rozgałęzianie i łączenie. Dzięki temu nad dokumentacją może pracować jednocześnie więcej niż jeden członek zespołu. Pomaga również zarządzać wszelkimi pojawiającymi się konfliktami.
Do strony można dodawać wszelkiego rodzaju bloki treści. Możesz użyć nagłówków, akapitów, bloków kodu lub wypunktowań, aby ponownie sformatować treść. Możesz zmienić typ podpowiedzi, komunikat i typ podpowiedzi, a także dostosować kolumny tabeli.
Karta Pliki umożliwia zarządzanie obrazami i załącznikami przesyłanymi do witryny. Linki do stron umożliwiają tworzenie dużych linków, które użytkownicy mogą łatwo zauważyć.
Jeśli tworzysz dokumentację związaną z językiem Go, możesz użyć Godoc. Godoc umożliwia automatyczne dokumentowanie kodu Go.
