Ξεκινώντας με το GitBook: Πώς να προσθέσετε μπλοκ περιεχομένου

Το GitBook είναι μια πλατφόρμα που επιτρέπει σε εσάς και την ομάδα σας να δημιουργείτε και να συνεργάζεστε σε ιστότοπους τεκμηρίωσης. Το GitBook το κάνει αυτό χρησιμοποιώντας έννοιες ελέγχου έκδοσης, όπως διακλάδωση και συγχώνευση.

Δεδομένου ότι πολλά μέλη της ομάδας μπορούν να εργαστούν σε έναν ιστότοπο τεκμηρίωσης, το GitBook σάς επιτρέπει να δημιουργείτε και να διαχειρίζεστε ξεχωριστά προσχέδια. Μπορείτε επίσης να δείτε τις διαφορές ανάμεσα στο τρέχον πρόχειρό σας και το κύριο αντίγραφο τεκμηρίωσης.

Υπάρχουν διάφοροι τύποι μπλοκ που μπορείτε να προσθέσετε στις σελίδες σας wiki. Αυτό περιλαμβάνει επικεφαλίδες, παραγράφους, εικόνες, συμβουλές, πίνακες, μπλοκ κώδικα, συνημμένα αρχεία και άλλα.

Πώς να προσθέσετε μπλοκ περιεχομένου στο GitBook

Μπορείτε να προβάλετε μια λίστα με τα διαθέσιμα μπλοκ περιεχομένου για προσθήκη σε μια σελίδα. Μπορείτε να το κάνετε αυτό κάνοντας κλικ οπουδήποτε στη σελίδα και κάνοντας κλικ στο συν σύμβολο που εμφανίζεται. Μπορείτε επίσης να αναζητήσετε απευθείας ένα συγκεκριμένο μπλοκ περιεχομένου.

Μπορείτε να προσθέσετε περιεχόμενο χρησιμοποιώντας το Markdown. Εάν δεν έχετε χρησιμοποιήσει το Markdown στο παρελθόν, μπορείτε να μάθετε περισσότερα πώς να ξεκινήσετε με το Markdown. Μπορείτε επίσης να διαβάσετε περισσότερα για γιατί το Markdown είναι τόσο δημοφιλές.

Πώς να προσθέσετε παραγράφους, λίστες, εισαγωγικά ή μπλοκ κώδικα

Για να προσθέσετε λίστες, παραγράφους, εισαγωγικά, μπλοκ κώδικα ή άλλα απλά μπλοκ περιεχομένου, ανοίξτε το αναπτυσσόμενο μενού και επιλέξτε από τους διαθέσιμους τύπους.

1. Σε μια σελίδα στον ιστότοπο τεκμηρίωσής σας, κάντε κλικ στο συν κουμπί στην τοποθεσία όπου θέλετε να προσθέσετε το περιεχόμενό σας.
2. Από το αναπτυσσόμενο μενού, μπορείτε να κάνετε κύλιση στη λίστα για να προβάλετε τις διάφορες επιλογές περιεχομένου.
3. Από εδώ, επιλέξτε οποιονδήποτε απλό τύπο περιεχομένου, όπως παράγραφο, μπλοκ κώδικα, επικεφαλίδα ή απόσπασμα. Το GitBook θα αλλάξει αυτόματα το περιεχόμενο ώστε να ταιριάζει με τη μορφή που έχετε επιλέξει.

Τρόπος προσθήκης εικόνων ή συνημμένων αρχείων

Για να προσθέσετε εικόνες, χρησιμοποιήστε το αναπτυσσόμενο μενού για να επιλέξετε το εικόνες επιλογή αποκλεισμού περιεχομένου. Για να προσθέσετε αρχεία, επιλέξτε το Εισαγωγή Αρχείων εναλλακτική επιλογή. Στη συνέχεια, μπορείτε να χρησιμοποιήσετε το δεξί πλαίσιο για να διαχειριστείτε τις μεταφορτωμένες εικόνες και τα αρχεία σας.

1. Ανοίξτε μια σελίδα στον ιστότοπο τεκμηρίωσής σας. Κάνε κλικ στο συν κουμπί για να ανοίξετε το αναπτυσσόμενο μενού για διαθέσιμα μπλοκ περιεχομένου.
2. Επιλέγω Εισαγωγή εικόνων.
3. Στο δεξί πλαίσιο που εμφανίζεται, υπάρχουν τρεις καρτέλες. ο Αρχεία Η καρτέλα σάς επιτρέπει να ανεβάσετε το δικό σας αρχείο εικόνας. ο URL Η καρτέλα σάς επιτρέπει να συνδέσετε μια εικόνα στο διαδίκτυο. Μπορείτε επίσης να ανοίξετε το Ξεβιδώστε αυτί. Εδώ μπορείτε να επιλέξετε υπάρχουσες φωτογραφίες που δεν απαιτούν αναφορά.
4. Αφού προσθέσετε μια εικόνα, κάντε κλικ στο τρεις τελείες κουμπί που βρίσκεται στην επάνω αριστερή γωνία της εικόνας. Αυτό θα ανοίξει ένα αναπτυσσόμενο μενού όπου μπορείτε να ευθυγραμμίσετε την εικόνα ή να τη διαγράψετε. Μπορείτε επίσης να δώσετε στην εικόνα μια λεζάντα.
5. Για να εισαγάγετε αρχεία, τοποθετήστε τον κέρσορα οπουδήποτε σε μια σελίδα στον ιστότοπο τεκμηρίωσής σας. Κάνε κλικ στο συν κουμπί για να ανοίξετε το αναπτυσσόμενο μενού τύπων μπλοκ περιεχομένου. Αυτή τη φορά, κάντε κλικ στο εισαγωγή αρχείων επιλογή.
6. Θα εμφανιστεί ένα παρόμοιο δεξί πλαίσιο, επιτρέποντάς σας να ανεβάσετε οποιοδήποτε συνημμένο αρχείο αντί για εικόνα. Κάντε κλικ στο ΕΞΕΡΕΥΝΗΣΗ ΑΡΧΕΙΩΝ για να επιλέξετε ένα αρχείο που είναι αποθηκευμένο τοπικά στον υπολογιστή σας.
7. Το αρχείο θα εμφανιστεί στη λίστα. Κάντε κλικ στο αρχείο και το GitBook θα δημιουργήσει ένα μπλοκ περιεχομένου με το συνημμένο αρχείο στη σελίδα που έχετε ανοίξει. Κάνοντας κλικ σε αυτό το μπλοκ περιεχομένου θα γίνει λήψη του συνημμένου αρχείου.

Πώς να προσθέσετε συμβουλές

Μπορείτε επίσης να προσθέσετε συμβουλές στη σελίδα σας. Μπορείτε να αλλάξετε το εικονίδιο για τις συμβουλές ώστε να χρησιμοποιούν κόκκινο για κίνδυνο, πορτοκαλί για προειδοποίηση, μπλε για πληροφορίες ή πράσινο για επιτυχία.

1. Για να προσθέσετε μια υπόδειξη, κάντε κλικ στο συν κουμπί για να ανοίξετε το αναπτυσσόμενο μενού για διαθέσιμα μπλοκ περιεχομένου.
2. Επιλέγω Ιχνος.
3. Αυτό θα προσθέσει μια υπόδειξη στη σελίδα σας. Από προεπιλογή, ο τύπος υπόδειξης είναι "πληροφορίες" και περιέχει ένα μπλε εικονίδιο.
4. Μπορείτε να αλλάξετε τον τύπο υπόδειξης κάνοντας κλικ στο εικονίδιο. Αυτό θα κάνει κύκλο στους τέσσερις διαφορετικούς τύπους υποδείξεων.

Πώς να προσθέσετε πίνακες

Μπορείτε να προσθέσετε πίνακες επιλέγοντας το τραπέζι επιλογή από την αναπτυσσόμενη λίστα. Αφού έχετε τον πίνακα στη σελίδα, μπορείτε να προσθέσετε νέες σειρές ή στήλες. Μπορείτε επίσης να τροποποιήσετε τα ονόματα και τους τύπους δεδομένων των στηλών και να αλλάξετε τα δεδομένα μέσα στον πίνακα.

1. Κάνε κλικ στο συν κουμπί για να ανοίξετε το αναπτυσσόμενο μενού για διαθέσιμα μπλοκ περιεχομένου.
2. Επιλέγω Τραπέζι.
3. Κάντε κλικ στην κεφαλίδα μιας στήλης στον πίνακα. Αυτό θα ανοίξει ένα νέο μικρότερο μενού, όπου μπορείτε να αλλάξετε το όνομα της επιλεγμένης στήλης. Αυτό το μενού σάς επιτρέπει επίσης να διαγράψετε ή να αποκρύψετε την επιλεγμένη στήλη. Για ορισμένους τύπους δεδομένων στήλης, μπορείτε επίσης να ευθυγραμμίσετε το περιεχόμενο μέσα στη στήλη.
4. Από προεπιλογή, ο επιλεγμένος τύπος δεδομένων για τις στήλες είναι "Κείμενο". Κάντε κλικ στο κουμπί με το Τ σύμβολο για να αλλάξετε τον τύπο δεδομένων. Μπορείτε να το αλλάξετε σε αριθμό, πλαίσιο ελέγχου, αναπτυσσόμενο μενού, συνημμένο αρχείου, βαθμολογία ή περισσότερα.
5. Κάνε κλικ στο εικονίδιο έξι κουκκίδων κοντά στην επάνω αριστερή γωνία του τραπεζιού. Εδώ μπορείτε να εισαγάγετε νέες στήλες και γραμμές ή να διαγράψετε ολόκληρο τον πίνακα. Μπορείτε επίσης να αποκρύψετε ή να εμφανίσετε ορισμένες στήλες ή να αλλάξετε άλλες ιδιότητες για τον πίνακα.

Πώς να προσθέσετε μπλοκ συνδέσμων σελίδας

Τα μπλοκ συνδέσμων σελίδας είναι σύνδεσμοι που καταλαμβάνουν ολόκληρη τη γραμμή στη σελίδα. Όταν προσθέτετε τον σύνδεσμο, πρέπει να συνδέσετε τη σελίδα που θα ανοίξει όταν κάποιος κάνει κλικ σε αυτήν.

1. Κάνε κλικ στο συν κουμπί για να ανοίξετε το αναπτυσσόμενο μενού για διαθέσιμα μπλοκ περιεχομένου.
2. Κάντε κλικ στο Σύνδεσμος σελίδας.
3. Από το νέο αναπτυσσόμενο μενού, επιλέξτε τη σελίδα στην οποία συνδέεστε.
4. Ο σύνδεσμος της σελίδας σας θα εμφανιστεί μέσα σε ένα μπλοκ στη σελίδα.

Χρήση του GitBook για τεκμηρίωση

Το GitBook είναι ένα εργαλείο τεκμηρίωσης που χρησιμοποιεί έννοιες ελέγχου έκδοσης, όπως διακλάδωση και συγχώνευση. Αυτό επιτρέπει σε περισσότερα από ένα μέλη της ομάδας να εργάζονται ταυτόχρονα στην τεκμηρίωση. Βοηθά επίσης στη διαχείριση τυχόν συγκρούσεων που συμβαίνουν.

Μπορείτε να προσθέσετε όλα τα είδη μπλοκ περιεχομένου σε μια σελίδα. Μπορείτε να χρησιμοποιήσετε επικεφαλίδες, παραγράφους, μπλοκ κώδικα ή κουκκίδες για να διαμορφώσετε ξανά το περιεχόμενό σας. Μπορείτε να αλλάξετε τον τύπο υπόδειξης, το μήνυμα και τον τύπο εικονιδίου των υποδείξεων, καθώς και να προσαρμόσετε τις στήλες ενός πίνακα.

Η καρτέλα Αρχεία σάς επιτρέπει να διαχειρίζεστε εικόνες και συνημμένα αρχείων που ανεβάζετε στον ιστότοπο. Οι Σύνδεσμοι Σελίδας σάς επιτρέπουν να δημιουργείτε μεγάλους συνδέσμους που οι χρήστες μπορούν εύκολα να εντοπίσουν.

Εάν δημιουργείτε τεκμηρίωση που σχετίζεται με τη γλώσσα Go, μπορείτε να χρησιμοποιήσετε το Godoc. Το Godoc σάς επιτρέπει να τεκμηριώνετε αυτόματα τον κωδικό Go σας.