Πώς να συμπεριλάβετε διαγράμματα γοργόνας στο έργο σας στο GitHub

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

Η γεύση του markdown του GitHub χειρίζεται ήδη εικόνες, λίστες εργασιών και σύντομους κωδικούς emoji. Με την υποστήριξη για κοινά διαγράμματα, το GitHub κάνει τα πάντα για πιο ενημερωτική και χρήσιμη τεκμηρίωση.

Τι νέο υπάρχει με το GitHub;

Τώρα μπορείτε να ενσωματώσετε τον κώδικα Mermaid στο δικό σας README.md και άλλα αρχεία σήμανσης. Εάν το κάνετε, το GitHub θα αποδώσει ένα διάγραμμα που περιγράφεται από αυτόν τον κώδικα. Ο κώδικας Mermaid χρησιμοποιεί μια απλή σύνταξη που περιγράφει τα μεμονωμένα μέρη κάθε διαγράμματος σε απλό κείμενο.

Δείτε επίσης: Τι είναι το GitHub; Εισαγωγή στα βασικά χαρακτηριστικά του

Πώς συμπεριλαμβάνετε διαγράμματα;

1. Επιλέξτε ένα υπάρχον αρχείο σήμανσης ή δημιουργήστε ένα νέο για να το προσθέσετε στο αποθετήριο σας. Χρησιμοποιήστε είτε .md ή .χαμήλωση τιμής επεκτάσεις.
instagram viewer
2. Προσθέστε λίγο κώδικα Mermaid σε αυτό το αρχείο. Ποιος ακριβώς κωδικός εξαρτάται από εσάς. εδώ είναι ένα απλό παράδειγμα για να ξεκινήσετε:

   γράφημα TD;
    Α-->Β;
    A-->C;
    B-->D;
    Γ-->Δ;

3. Δείτε το αρχείο στο GitHub. Θα πρέπει να δείτε μια ωραία απόδοση του διαγράμματός σας.

Τώρα χρειάζεται απλώς να μάθετε τον πλούτο των διαγραμμάτων που διαθέτει το Mermaid. Ή μπορείτε απλά να ανατρέξετε στο Γοργόνα τεκμηρίωση όπως και όταν χρειάζεστε ένα διάγραμμα.

Τι είδους διαγράμματα μπορώ να χρησιμοποιήσω;

Το Mermaid υποστηρίζει τους ακόλουθους τύπους διαγραμμάτων:

• ΔΙΑΓΡΑΜΜΑ ΡΟΗΣ
• Αλληλουχία
• Τάξη
• κατάσταση
• Σχέση οντοτήτων
• Ταξίδι χρήστη
• Gantt
• Πίτα
• Απαίτηση

Δείτε επίσης: Διάγραμμα Gantt vs. Διάγραμμα PERT: Ποιες είναι οι διαφορές;

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

Διάγραμμα ακολουθίας
 Bart->>Homer: Μην έχεις αγελάδα, φίλε.

Το οποίο μοιάζει με αυτό όταν αποδίδεται:

Και εδώ είναι ο κώδικας για ένα βασικό διάγραμμα κατάστασης:

StateDiagram-v2
 [*] --> Νέο
 Νέο --> Έτοιμο: αποδεκτό
 Έτοιμο --> Εκτέλεση: αποστολή προγραμματιστή
 Εκτέλεση --> Έτοιμος: διακοπή
 Εκτέλεση --> Αναμονή: I/O ή αναμονή συμβάντος
 Αναμονή --> Έτοιμο: I/O ή ολοκλήρωση συμβάντος
 Εκτέλεση --> Τερματίστηκε: έξοδος
 Τερματίστηκε --> [*]

Το οποίο αποδίδει ως εξής:

Προσθέστε αξία στα έργα σας στο GitHub με τα διαγράμματα Mermaid

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

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

Πώς να φιλοξενήσετε έναν ιστότοπο δωρεάν χρησιμοποιώντας σελίδες GitHub

Εάν έχετε έναν απλό ιστότοπο, δεν χρειάζεται να πληρώσετε για τη φιλοξενία ιστοσελίδων. Μπορείτε να χρησιμοποιήσετε τις Σελίδες GitHub δωρεάν!

Διαβάστε Επόμενο

Σχετικά με τον Συγγραφέα