Ένα από τα πιο σημαντικά καθήκοντα κατά τη δημιουργία λογισμικού είναι η τεκμηρίωση, δυστυχώς για όσους από εμάς που αναπτύσσουμε αυτό το έργο μερικές φορές φαίνεται κουραστικό, αλλά δεν είναι μυστικό ότι η καλή τεκμηρίωση μπορεί να είναι το σημείο επιτυχίας οποιουδήποτε εργαλείου, καθώς είτε για τη βοήθεια που δίνεται στους χρήστες να κατανοήσουν τη σωστή λειτουργία της εφαρμογής ή τις πληροφορίες που παρέχονται σε άλλους προγραμματιστές για τη βελτίωσή της.
Υπάρχουν αρκετά καλές εφαρμογές που μας επιτρέπουν να τεκμηριώσουμε τα έργα μας με απλό τρόπο, μερικές τείνουν να προσφέρουν περισσότερα από ό, τι πραγματικά θέλουμε και άλλες απαιτούν περίπλοκες εγκαταστάσεις, εργαλείο τεκμηρίωσης έργων που συμμορφώνεται και είναι αρκετά απλό στη χρήση και εγκατάσταση είναι το Docusaurus.
Τι είναι ο Docusaurus;
Ντοκόσαυρος είναι ένα έργο για δημιουργία, υλοποίηση και συντήρηση τεκμηρίωσης ιστού εργαλείων ανοιχτού κώδικα, επιτρέπει τη χρήση της γλώσσας Χαμήλωση τιμής Για να γράψουμε την τεκμηρίωση που αργότερα θα δημοσιευτεί ως ιστότοπος html, με τον ίδιο τρόπο, το εργαλείο μας επιτρέπει να επεκτείνουμε και να προσαρμόσουμε το σχεδιασμό του ιστότοπου τεκμηρίωσης με τη χρήση του React.
Σε γενικές γραμμές, αυτό το εργαλείο ανοιχτού κώδικα που αναπτύχθηκε από την ομάδα προγραμματισμού του Facebook μας επιτρέπει να δημιουργούμε εύκολα όμορφες και ελαφριές ιστοσελίδες όπου μπορούμε να προβάλλουμε επαρκώς την τεκμηρίωση οποιουδήποτε έργου.
Το εργαλείο είναι εξοπλισμένο με λειτουργίες για τη σωστή έκδοση εγγράφων, μια προηγμένη μηχανή αναζήτησης, τη δυνατότητα τεκμηρίωσης και επανασχεδιασμού του ιστότοπου τεκμηρίωσης σε πραγματικό χρόνο, ενσωμάτωση με μεταφράσεις και πολλές άλλες δυνατότητες που θα σας βοηθήσουν να ανησυχείτε λιγότερο για την τεκμηρίωση ή μάλλον για τη δημιουργία η διαδικασία τεκμηρίωσης ευκολότερη και με πιο ευχάριστο φινίρισμα.
Η εύκολη χρήση του Docusaurus φαίνεται στο παρακάτω gif που διανέμεται από τους προγραμματιστές του
Πώς να εγκαταστήσετε το Docusaurus;
Ο κύριος στόχος του Docusaurus είναι να είναι το οριστικό εργαλείο για την τεκμηρίωση εφαρμογών ανοιχτού κώδικα που φιλοξενούνται στο github, επομένως είναι πολύ εύκολο να εγκαταστήσετε και να εκτελέσετε τον ιστότοπο τεκμηρίωσης σε αυτήν την πλατφόρμα.
Για να αρχίσετε να απολαμβάνετε το Docusaurus στο Github, απλώς ακολουθήστε τα βήματα που υποδεικνύει η ομάδα ανάπτυξης και που παραθέτουμε παρακάτω:
- Μεταβείτε στη ρίζα του καταλόγου αποθετηρίου GitHub όπου θα δημιουργήσετε τα έγγραφα και θα εκτελέσετε τις ακόλουθες εντολές:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Το τελικό αποτέλεσμα θα είναι η δημιουργία μιας δομής αρχείου και καταλόγου όπως φαίνεται παρακάτω:
Ενδιαφέρον σφάλμα για δοκιμή!