Δημιουργία τεκμηρίωσης με αρχεία Markdown χρησιμοποιώντας το Docsify
Αν δημιουργείτε ένα δωρεάν plugin, πλαίσιο ή ανοιχτό κώδικα θα χρειαστείτε τεκμηρίωση. Είναι κρίσιμο τεκμηρίωση της εργασίας σας, τόσο για τη λογική σας όσο και για να βοηθήσετε άλλους που θέλουν να μάθουν τον τρομερό σας πόρο.
Ωστόσο, η δημιουργία ηλεκτρονικής τεκμηρίωσης μπορεί να είναι ένας πραγματικός πόνος. Ευγνομονώς, Έγγραφο αναφοράς καθιστά ευκολότερη την παροχή ενός δωρεάν γεννήτρια τεκμηρίωσης που εκτελείται σε Markdown.
Αυτό είναι όχι μια τυπική γεννήτρια στατικών τοποθεσιών και το κάνει δεν απαιτούν στατικές σελίδες HTML / CSS. Αντ 'αυτού, αυτό φορτώνει τα αρχεία Markdown δυναμικά και τα εμφανίζει ως ιστοσελίδες. Αρκετά τακτοποιημένο!
Ελέγξτε την αρχική σελίδα του Docsify για ένα προεπισκόπηση της διάταξης, μαζί με περαιτέρω λεπτομέρειες εγκατάστασης.
Απαιτεί ότι εσείς δημιουργήστε τον εαυτό σας index.html αρχείο, τα οποία στη συνέχεια μπορούν να μεταφορτωθούν σε σελίδες GitHub ή να φιλοξενηθούν στον δικό σας διακομιστή. Από εκεί, απλά γράψτε τα αρχεία Markdown για κάθε σελίδα και να τα χρησιμοποιήσετε ως πρωταρχικά σας έγγραφα.
Η όλη διαδικασία περιγράφεται λεπτομερώς στο οδηγός γρήγορης εκκίνησης, έτσι είναι ίσως το καλύτερο μέρος για να ξεκινήσετε. Αυτό μπορεί όλα τρέχουν μέσω npm, οπότε βοηθά πραγματικά να γνωρίζετε την εντολή σας ή τουλάχιστον να είστε πρόθυμοι να μάθετε.
Είναι δυνατό να δημιουργήσετε μόνοι σας ένα πρωτότυπο αρχείο HTML και απλά να αντιγράψετε / επικολλήσετε το πρότυπο από τον οδηγό ρύθμισης του Docsify. Αλλά, συνιστώ να το κάνει δυναμικά, δεδομένου ότι σώζει έναν τόνο χρόνου - και δεν είναι πραγματικά αυτό το σημείο?
Καθώς μαθαίνετε το σύστημα Docsify, μπορείτε προσθέστε λειτουργίες χρησιμοποιώντας Markdown ή raw HTML. Αυτά τα χαρακτηριστικά περιλαμβάνουν ένα προσαρμοσμένη γραμμή πλοήγησης και ακόμα τη δική σας σελίδα κάλυψης με το λογότυπο του έργου σας.
Έγγραφο με έγγραφα έρχεται συσκευασμένο με μια δέσμη δωρεάν θέματα αν θέλετε να σχεδιάσετε προσχεδιασμένες διατάξεις. Ή, μπορείτε περιηγηθείτε στη συλλογή των βιτρινών τους για να δείτε ποια έργα χρησιμοποιούν το Έγγραφο για την τεκμηρίωσή τους.
Ολα τα βασικές πληροφορίες εγκατάστασης και λήψεις αρχείων μπορείτε να βρείτε στο GitHub, οπότε κατευθυνθείτε εκεί εάν θέλετε να δώσετε μια φωτογραφία.
Μπορείτε επίσης να δείτε μια ζωντανή επίδειξη στην κύρια σελίδα τεκμηρίωσης Docsify το οποίο, ασφαλώς, τρέχει στο Docsify. Έτσι, αν σας αρέσει αυτή η διάταξη ιστοσελίδας μπορείτε να χρησιμοποιήσετε το ίδιο πρότυπο και να το εκτελέσετε όλα μέσα από το Docsify, 100% δωρεάν και ανοιχτού κώδικα.
