GitBook to platforma umożliwiająca budowanie witryn z dokumentacją lub firmowych wiki. Możesz go używać do dokumentowania wszelkiego rodzaju rzeczy, od kodu po interfejsy API i sposób korzystania z oprogramowania.

GitBook wykorzystuje podobny proces do repozytoriów GitHub. Kopia główna dokumentacji pełni funkcję kopii „wzorcowej”. Następnie możesz tworzyć „szkice”, które są podobne do „gałęzi”.

Ten proces pozwala wielu użytkownikom pracować na jednej witrynie z dokumentacją, jednocześnie obsługując lub zapobiegając konfliktom. Umożliwia również przejrzenie zmian z różnych gałęzi przed ich scaleniem.

Jak zacząć korzystać z GitBooka

Do wyboru kilka Cennik GitBooka plany. Ceny będą zależeć od tego, czy używasz GitBook do projektów typu open source, użytku osobistego, czy prywatnej współpracy zespołowej. GitBook jest darmowy, jeśli używasz go do projektów open source.

GitBook obsługuje Markdown, popularny język znaczników z wieloma zaletami do pisania lub dokumentowania w Internecie.

GitBook integruje się również z

instagram viewer
GitHub, platforma do hostingu, przechowywania i edycji kodu. Możesz połączyć swoje konto GitBook bezpośrednio z kontem GitHub, logując się przy użyciu poświadczeń GitHub.

  1. Zarejestruj się na GitBook. Jeśli masz własne konto GitHub, możesz kliknąć Zarejestruj się przez GitHub.
  2. Po zalogowaniu się, GitBook przekieruje Cię do nowej wewnętrznej wiki. Spowoduje to również wstępne wypełnienie Twojej wiki przykładową treścią.

Przegląd interfejsu GitBook

GitBook ma kilka funkcji, które pozwalają budować i wprowadzać zmiany w witrynie z dokumentacją.

  1. Górny panel umożliwia tworzenie nowych wersji roboczych, przeglądanie historii zmian lub przeglądanie wszelkich innych dyskusji lub załączników.
  2. Pasek boczny po lewej stronie umożliwia tworzenie wielu spacji. Możesz używać oddzielnych przestrzeni dla różnych projektów, dzięki czemu możesz oddzielić i uporządkować obszary dokumentacji. Możesz rozwinąć lub zamknąć pasek boczny.
  3. Lewy panel pełni rolę menu strony z dokumentacją. Możesz przeglądać strony w witrynie dokumentacji i używać ich do tworzenia grup i stron zagnieżdżonych. Możesz także poruszać się po witrynie, korzystając z podanych linków.
  4. Dolny panel zawiera przyciski, które są kluczowe dla procesu kontroli wersji. Możesz dodać nazwę do wersji roboczej, scalić zmianę lub przesłać zmianę do recenzji.

Jak stworzyć nową wersję roboczą

Możesz utworzyć nową wersję roboczą, tworząc nowe żądanie zmiany i wprowadzając w nim zmiany.

  1. W górnym panelu kliknij Prośby o zmianę.
  2. W nowym panelu, który pojawi się po prawej stronie, kliknij Projekt patka. Spowoduje to wyświetlenie wszystkich aktywnych wersji roboczych.
  3. Stąd możesz kliknąć istniejącą wersję roboczą, aby ją otworzyć. Aby utworzyć nową wersję roboczą, kliknij Nowe żądanie zmianyi poczekaj na zakończenie ładowania strony.
  4. W dolnym panelu kliknij Wpisz temat. Otworzy się okno, w którym możesz nadać nazwę nowej wersji roboczej. Na przykład, Nowa strona - Jak skonfigurować Codebase.

Jak tworzyć strony i grupy

Gdy masz już wersję roboczą, możesz zacząć wprowadzać zmiany w dokumentacji. GitBook przechowuje twoje zmiany w wersji roboczej, więc nie wpływają one na kopię główną. Możesz użyć paska bocznego po lewej stronie, aby dodać strony i grupy stron.

  1. Utwórz nową stronę, klikając Nowa strona link na dole paska bocznego i wybierając Nowa strona dokumentu z listy rozwijanej. Możesz też najechać kursorem na istniejącą stronę i kliknąć niebieski plus przycisk.
  2. Aby utworzyć nową grupę stron, kliknij Nowa stronai wybierz Nowa grupa opcja z listy rozwijanej.
  3. Możesz zmienić nazwę strony, klikając trzy kropki obok strony lub grupy i wybierając Przemianować.
  4. Rozpocznij dodawanie treści, aby wypełnić nową stronę. Możesz dodać prostą treść, taką jak tekst lub nagłówki. GitBook umożliwia również dodawanie innych bloków treści, takich jak obrazy, załączniki plików, tabele, karty lub fragmenty kodu. Istnieje również możliwość dodania innych integracji, takich jak osadzanie z YouTube lub zawartość Dokumentów Google.
  5. Kliknij na Widok różnic w dolnym panelu, aby zobaczyć różnice między wersją roboczą a oryginalną kopią głównej dokumentacji.
  6. Po zakończeniu pisania treści możesz kliknąć Łączyć, Prześlij i scal, lub Przekaż do oceny.

Możesz uzyskać dostęp do łącza udostępniania z górnego panelu GitBook. Aby wyświetlić łącze, musisz wyjść z wersji roboczej i przejrzeć główną kopię dokumentacji.

  1. Domyślnie widoczność Twojej witryny z dokumentacją jest „niepubliczna”. Oznacza to, że dostęp do strony z dokumentacją można uzyskać za pomocą prywatnego łącza, a nie za pomocą wyszukiwarek. W górnym panelu kliknij Nie katalogowany przycisk.
  2. Wybierz żądane ustawienia widoczności z menu. Pamiętaj, że GitBook może blokować niektóre ustawienia widoczności i może być konieczne uaktualnienie, aby uzyskać do nich dostęp.
  3. Pod listą ustawień widoczności znajduje się łącze, które możesz udostępnić innym użytkownikom, którzy będą korzystać z Twojej witryny z dokumentacją. Skopiuj ten link, aby udostępnić go innym.
  4. Pod linkiem kliknij Ustawienia linków i domen. Tutaj możesz połączyć niestandardową nazwę domeny lub zmodyfikować część adresu URL. Jeśli korzystasz z domeny niestandardowej, możesz wyświetlić Dokumentacja Gitbooka jak poprawnie skonfigurować swój DNS.

Tworzenie dokumentacji za pomocą GitBook

GitBook pozwala na wspólne tworzenie i pracę na stronach dokumentacji lub firmowych wiki. GitBook pożycza koncepcje z GitHub, takie jak gałęzie i łączenie, aby kontrolować kopię główną i zarządzać wszelkimi konfliktami.

Możesz utworzyć nową wersję roboczą, aby dodać własne indywidualne zmiany do dokumentacji. W wersji roboczej możesz wprowadzać zmiany w treści, a także dodawać nowe strony lub grupy stron. Po zakończeniu wprowadzania zmian możesz je scalić lub przesłać do sprawdzenia.

Jeśli tworzysz wewnętrzną dokumentację kodu Java, możesz chcieć zapoznać się z dokumentacją Javadoc. Javadoc umożliwia automatyczne dokumentowanie kodu Java.