Το GitBook είναι ένα εργαλείο γραμμής εντολών που βασίζεται σε Node.js που υποστηρίζει μορφές σύνταξης Markdown και AsciiDoc και μπορεί να εξάγει ηλεκτρονικά βιβλία σε HTML, PDF, eBook και άλλες μορφές.
Εγκαταστήστε node.js
Πριν χρησιμοποιήσετε το εργαλείο gitbook, ο υπολογιστής πρέπει να εγκαταστήσει node.js περιβάλλον και μετά την εγκατάσταση, μπορείτε να ελέγξετε την εντολή έκδοσης για να ελέγξετε εάν η εγκατάσταση είναι επιτυχής:
Εγκαταστήστε το Gitbook
Το Gitbook εγκαθίσταται με npm, γραμμή εντολών:
Εκτελέστε την παρακάτω εντολή για να δείτε την έκδοση GitBook για να επαληθεύσετε ότι η εγκατάσταση ήταν επιτυχής.
Εγκατάσταση ιστορικών εκδόσεων
Το gitbook-cli διευκολύνει τη λήψη και εγκατάσταση άλλων εκδόσεων του GitBook για να δοκιμάσετε τα βιβλία σας:
Η χρήση του gitbook ls-remote απαριθμεί τις εκδόσεις που μπορούν να ληφθούν.
Επεξεργαστής Markdown
Εδώ χρησιμοποιούμε τη σύνταξη Markdown ως γλώσσα γραφής για τα έγγραφά μας, πρέπει να προετοιμάσουμε έναν επεξεργαστή Markdown, μπορούμε να βρούμε πολλούς επεξεργαστές Markdown στην αγορά, όπως Typora, MacDown, Bear, MarkdownPad, MarkdownX, IDE του JetBrains (απαιτείται εγκατάσταση προσθήκης), Atom, Jianshu, CSDN και το δικό του GitBook Επεξεργαστής GitBook και ούτω καθεξής.
Έχω εγκατεστημένα εργαλεία ανάπτυξης κώδικα VS στον υπολογιστή μου, έναντι κώδικα που υποστηρίζει σήμανση από προεπιλογή, χρειάζεται μόνο να εγκαταστήσω ένα τεχνούργημα προσθήκης προεπισκόπησης: Markdown Preview Enhanced και θα το χρησιμοποιήσω!
Συνιστάται από φίλους Συντάκτης τυπογραφίας, διεύθυνση:Η σύνδεση με υπερσύνδεσμο είναι ορατή.
Αρχικοποίηση βιβλίου
Το GitBook μπορεί να δημιουργήσει ένα boilerplate:
Εάν θέλετε να δημιουργήσετε ένα βιβλίο σε έναν νέο κατάλογο, μπορείτε να το κάνετε εκτελώντας το gitbook init ./directory.
Μετά την εκτέλεση, θα δείτε δύο ακόμη αρχεία - README.md και SUMMARY.md, τα οποία κάνουν τα εξής:
README.md - Η εισαγωγή του βιβλίου είναι γραμμένη σε αυτό το έγγραφο SUMMARY.md - Η δομή του καταλόγου του βιβλίου διαμορφώνεται εδώ
Δεν είμαι εξοικειωμένος με τη σύνταξη markdown, οπότε γράψτε μερικές προτάσεις!
Δημιουργία στατικών ιστοσελίδων
Δημιουργία στατικών ιστοσελίδων και εκτέλεση διακομιστών
Όλα τα παραπάνω θα δημιουργηθούν στον κατάλογο βιβλίων _book.
Η εντολή serve μπορεί επίσης να καθορίσει τη θύρα:
Κατά τη δημιουργία, καθορίστε την έκδοση του gitbook και δεν θα γίνει πρώτα λήψη του τοπικά
Παραθέτει όλες τις τοπικές εκδόσεις gitbook
Λίστα των εκδόσεων του gitbook που είναι διαθέσιμες εξ αποστάσεως
Εγκαταστήστε την αντίστοιχη έκδοση gitbook
Ενημέρωση στην πιο πρόσφατη έκδοση του gitbook
Απεγκαταστήστε την αντίστοιχη έκδοση gitbook
Καθορίζει το επίπεδο καταγραφής
Μήνυμα σφάλματος εξόδου
Συνοπτικά
Το GitBook χρησιμοποιεί SUMMARY.md αρχεία για να καθορίσει τη δομή των κεφαλαίων και των υποκεφαλαίων του βιβλίου. SUMMARY.md Αρχείο χρησιμοποιείται για τη δημιουργία του πίνακα περιεχομένων του βιβλίου.
Η μορφή του SUMMARY.md είναι μια λίστα συνδέσμων. Ο τίτλος του συνδέσμου θα χρησιμεύσει ως τίτλος του κεφαλαίου και ο σύνδεσμος θα στοχεύει στη διαδρομή προς αυτό το αρχείο κεφαλαίου.
Η προσθήκη μιας ένθετης λίστας στο γονικό κεφάλαιο δημιουργεί ένα θυγατρικό κεφάλαιο.
Απλό παράδειγμα:
Στη συνέχεια, επιστρέφουμε στη γραμμή εντολών και εκτελούμε ξανά την εντολή gitbook init στο φάκελο mybook. Το GitBook αναζητά καταλόγους και αρχεία που περιγράφονται σε SUMMARY.md αρχεία,Εάν όχι, δημιουργείται。
Έξοδος αρχείων PDF, ePub ή mobi
Εάν θέλετε να δημιουργήσετε μια έκδοση pdf, μπορείτε να εκτελέσετε το gitbook pdf, με τον ίδιο τρόπο, εάν εξάγετε μορφή epub, gitbook epub, εάν είναι μορφή mobi, το gitbook mobi θα κάνει.
Εάν θέλετε να εξαγάγετε ένα ηλεκτρονικό βιβλίο σε μορφή PDF, ePub ή mobi,Απαιτεί το Caliber eBook Reader/Manager και τα εργαλεία γραμμής εντολών, διαφορετικά μπορεί να αναφερθεί ένα σφάλμα "EbookError: Σφάλμα κατά τη δημιουργία ebook: 'ebook-convert'".
Χαρακτηριστικά των ειδικών αρχείων GitBook:
Αρχείο | περιγραφή | | book.json | Δεδομένα διαμόρφωσης (προαιρετικά) | | README.md | Πρόλογος ή εισαγωγή στο eBook (υποχρεωτικό) | | SUMMARY.md | Κατάλογος ηλεκτρονικών βιβλίων (προαιρετικό) | | GLOSSARY.md | Λίστα όρων λεξιλογίου/σχολιασμού (προαιρετικά) | Γενικές ρυθμίσεις Gitbook
Το GitBook σάς επιτρέπει να προσαρμόσετε το ebook σας με ευέλικτες διαμορφώσεις.
Αυτές οι επιλογές καθορίζονται στο αρχείο book.json. Για συντάκτες που δεν είναι εξοικειωμένοι με τη σύνταξη JSON, μπορείτε να επαληθεύσετε τη σύνταξη χρησιμοποιώντας εργαλεία όπως το JSONlint.
μεταβλητή | περιγραφή | | ρίζα | Η διαδρομή προς τον ριζικό φάκελο που περιέχει όλα τα αρχεία του βιβλίου, εκτός από book.json | | Δομή | Καθορίστε διαδρομές για readme, περιλήψεις, γλωσσάρια κ.λπ | | Τίτλος | Ο τίτλος του βιβλίου σας, η προεπιλεγμένη τιμή εξάγεται από το README. Στις GitBook.com, αυτό το πεδίο είναι προσυμπληρωμένο. | | περιγραφή{filter}tion | Η περιγραφή του βιβλίου σας, η προεπιλεγμένη τιμή εξάγεται από το README. Στις GitBook.com, αυτό το πεδίο είναι προσυμπληρωμένο. | | Συγγραφέας | Όνομα συγγραφέα. Στις GitBook.com, αυτό το πεδίο είναι προσυμπληρωμένο. | | ISBN | ISBN | | Γλώσσα | Ο τύπος γλώσσας αυτού του βιβλίου είναι ο κωδικός ISO. Η προεπιλεγμένη τιμή είναι en | | Κατεύθυνση | Σειρά ανάγνωσης κειμένου. Μπορεί να είναι RTL (από δεξιά προς τα αριστερά) ή LTR (από αριστερά προς τα δεξιά) και η προεπιλεγμένη τιμή εξαρτάται από την τιμή της γλώσσας. | | βιβλίο gitbook | Θα πρέπει να χρησιμοποιηθεί η έκδοση GitBook. Χρησιμοποιήστε την προδιαγραφή SemVer και αποδεχτείτε συνθήκες παρόμοιες με "> = 3.0.0". |
|