GitBook to narzędzie poleceń oparte na Node.js, które obsługuje składnie Markdown i AsciiDoc oraz może generować e-booki w formatach HTML, PDF, eBook i innych.
Instalacja node.js
Przed użyciem narzędzia gitbook komputer musi zainstalować środowisko node.js, a po instalacji możesz sprawdzić polecenie version, aby sprawdzić, czy instalacja się powiodła:
Zainstaluj Gitbook
Gitbook jest zainstalowany z npm, wiersz poleceń:
Uruchom poniższe polecenie, aby zobaczyć wersję GitBooka i potwierdzić, że instalacja się powiodła.
Instalacja wersji historycznych
gitbook-cli ułatwia pobieranie i instalowanie innych wersji GitBooka w celu testowania książek:
Używając gitbook ls-remote, wypisuje wersje, które można pobrać.
Edytor Markdown
Tutaj używamy składni Markdowna jako języka pisma do naszych dokumentów, musimy przygotować edytor Markdown, na rynku można znaleźć wiele edytorów Markdown, takich jak Typora, MacDown, Bear, MarkdownPad, MarkdownX, IDE JetBrains (wymaga instalacji wtyczki), Atom, Jianshu, CSDN oraz własny edytor GitBooka GitBook Editor i tak dalej.
Mam zainstalowane narzędzia do tworzenia kodu VS na komputerze, VS Code domyślnie obsługuje markdown, wystarczy zainstalować artefakt wtyczki podglądowej: Markdown Preview Enhanced, i będę z niego korzystał!
Polecane przez przyjaciół Redaktor typora, adres:Logowanie do linku jest widoczne.
Inicjalizacja książki
GitBook może ustawić szablon (boilerplate'):
Jeśli chcesz utworzyć książkę w nowym katalogu, możesz to zrobić, uruchamiając gitbook init ./directory.
Po wykonaniu zobaczysz jeszcze dwa pliki – README.md i SUMMARY.md, które wykonują następujące czynności:
README.md - Wstęp do książki zawarty jest w tym dokumencie
SUMMARY.md - Struktura katalogu książki jest skonfigurowana tutaj
Nie znam składni markdown, więc napisz kilka zdań!
Generuj statyczne strony internetowe
Generuj statyczne strony internetowe i uruchamiaj serwery
Wszystko powyższe zostanie opublikowane w katalogu książek _book.
Polecenie serve może również określić port:
Podczas generowania określ wersję gitbooka i nie zostanie on najpierw pobrany lokalnie
Lista wszystkich lokalnych wersji gitbooków
Wymień wersje gitbooka dostępne zdalnie
Zainstaluj odpowiednią wersję gitbooka
Aktualizacja do najnowszej wersji gitbooka
Odinstaluj odpowiednią wersję gitbooka
Określa poziom logu
Komunikat o błędzie wyjściowym
Podsumowanie
GitBook używa SUMMARY.md plików do definiowania struktury rozdziałów i podrozdziałów książki. SUMMARY.md plik służy do generowania spisu treści książki.
Format SUMMARY.md to lista linków. Tytuł linku będzie służył jako tytuł rozdziału, a link będzie skierowany do ścieżki do pliku rozdziału.
Dodanie listy zagnieżdżonej do rozdziału nadrzędnego tworzy rozdział potomny.
Prosty przykład:
Następnie wracamy do wiersza poleceń i ponownie uruchamiamy polecenie gitbook init w folderze mybook. GitBook szuka katalogów i plików opisanych w SUMMARY.md plikach,Jeśli nie, jest tworzona。
Wypisz pliki PDF, ePub lub mobi
Jeśli chcesz wygenerować wersję pdf, możesz uruchomić gitbook pdf, tak samo, jeśli eksportujesz format epub, gitbook epub, jeśli jest to format mobi, gitbook mobi wystarczy.
Jeśli chcesz wyeksportować e-booka w formacie PDF, ePub lub mobi,Wymaga to Calibre Reader/Manager eBook oraz narzędzi do linii poleceń, w przeciwnym razie może zostać zgłoszony błąd "EbookError: Error during ebook generation: 'ebook-convert'".
Cechy plików specjalnych GitBook:
plik | opis | | book.json | Dane konfiguracyjne (opcjonalne) | | README.md | Przedmowa lub wprowadzenie do eBooka (wymagane) | | SUMMARY.md | Katalog e-booków (opcjonalnie) | | GLOSSARY.md | Lista terminów słownictwa/adnotacji (opcjonalnie) |
Ogólne ustawienia Gitbooka
GitBook pozwala dostosować ebooka do elastycznych konfiguracji.
Opcje te są określone w pliku book.json. Dla autorów, którzy nie znają składni JSON, można zweryfikować składnię za pomocą narzędzi takich jak JSONlint.
zmienna zmienna | opis | | korzeń | Ścieżka do folderu głównego, który zawiera wszystkie pliki książek, z wyjątkiem book.json | | Struktura | Określ ścieżki dla readme, streszczenia, słowników itd | | Tytuł | Tytuł twojej książki, domyślna wartość jest wyodrębniona z pliku README. Na GitBook.com to pole jest wstępnie wypełnione. | | descrip{filter}tion | Opis twojej książki, domyślna wartość, jest wyodrębniona z pliku README. Na GitBook.com to pole jest wstępnie wypełnione. | | Autor | Nazwisko autora. Na GitBook.com to pole jest wstępnie wypełnione. | | ISBN | ISBN | | Język | Typ językowy tej książki to kod ISO. Domyślna wartość to en | | Kierunek | Kolejność czytania tekstu. Może to być RTL (od prawej do lewej) lub LTR (od lewej do prawej), a wartość domyślna zależy od wartości języka. | | gitbook | Należy używać wersji GitBook. Użyj specyfikacji SemVer i zaakceptuj warunki podobne do "> = 3.0.0". |
|
Opublikowano 23.11.2018 14:03:54
|
|
|
|
