Πώς να χρησιμοποιήσετε γρήγορα το Markdown στο GitHub και το Reddit

Informatec Digital » Πόροι » Πώς να χρησιμοποιήσετε γρήγορα το Markdown στο GitHub και το Reddit

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

Στο GitHub, θα το βρείτε παντού: στο αποθετήριο, στα αρχεία README.md , σε θέματα, σε αιτήματα έλξης, σε συζητήσεις, ακόμη και στο δικό σας προφίλ. Το Reddit, από την άλλη πλευρά, χρησιμοποιεί μια παραλλαγή που ονομάζεται Snoomark (Markdown τύπου Reddit) η οποία κληρονομεί μεγάλο μέρος της σύνταξης του GitHub, με ορισμένα μοναδικά χαρακτηριστικά και περιορισμούς. Ας δούμε, βήμα προς βήμα και με πολλά παραδείγματα, πώς να χρησιμοποιήσετε το Markdown στο GitHub και το Reddit γρήγορα και χωρίς να χάσετε τίποτα σημαντικό.

Τι είναι το Markdown και γιατί είναι τόσο χρήσιμο στο GitHub και το Reddit;

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

Στο GitHub, η υλοποίηση που χρησιμοποιείται είναι το GitHub Flavored Markdown (GFM), το οποίο επεκτείνει την κλασική σύνταξη με πίνακες, λίστες υποχρεώσεων, προηγμένη επισήμανση κώδικα, υποστήριξη χρωμάτων, ειδοποιήσεις και ορισμένες επιτρεπόμενες ετικέτες HTML. Όλα αυτά αποδίδονται αυτόματα σε αρχεία .md και στα πεδία σχολίων της πλατφόρμας.

Το Reddit χρησιμοποιεί το δικό του πρόγραμμα επεξεργασίας που ονομάζεται Snoomark, ένα παράγωγο του GFM. Μοιράζεται μεγάλο μέρος της βασικής συμπεριφοράς (έντονη γραφή, πλάγια γραφή, επικεφαλίδες, λίστες, εισαγωγικά, ενσωματωμένο ή μπλοκ κώδικα, συνδέσμους κ.λπ.), αλλά έχει σημαντικές ιδιαιτερότητες : για παράδειγμα, η υποστήριξη εικόνων είναι πιο περιορισμένη ανάλογα με τα συμφραζόμενα και προσθέτει τα δικά της στοιχεία, όπως spoilers.

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

Επικεφαλίδες και δομή περιεχομένου

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

Στο Markdown, μια επικεφαλίδα δημιουργείται προτάσσοντας το κείμενο με ένα έως έξι σύμβολα κατακερματισμού: ένα για μια επικεφαλίδα επιπέδου 1, δύο για το επίπεδο 2 και ούτω καθεξής έως το επίπεδο 6. Για παράδειγμα, σε ένα αρχείο README.md του GitHub μπορεί να έχετε κάτι σαν: # Κύριος Τίτλος , ## Ενότητα , ### Υποενότητα , κ.λπ.

Όταν το GitHub εντοπίζει δύο ή περισσότερες επικεφαλίδες σε ένα αρχείο, δημιουργεί αυτόματα έναν πίνακα περιεχομένων στον οποίο έχετε πρόσβαση από το εικονίδιο "Περίγραμμα" στο επάνω μέρος του αρχείου. Κάθε επικεφαλίδα εμφανίζεται ως σύνδεσμος που σας μεταφέρει απευθείας σε αυτήν την ενότητα, κάτι που είναι ιδανικό για μεγάλα έγγραφα.

Επιπλέον, κάθε επικεφαλίδα γίνεται μια εσωτερική άγκυρα στην οποία μπορείτε να συνδεθείτε με ένα απόσπασμα URL με βάση το κείμενο του τίτλου. Για να δημιουργήσει αυτό το απόσπασμα, το GitHub εφαρμόζει πολύ συγκεκριμένους κανόνες: μετατρέπει τα γράμματα σε πεζά, αντικαθιστά τα κενά με παύλες, αφαιρεί τους χαρακτήρες στίξης και μορφοποίησης (όπως πλάγια γραφή), αφαιρεί τα επιπλέον κενά και, εάν το αποτέλεσμα ταιριάζει με μια άλλη προηγούμενη επικεφαλίδα, προσθέτει ένα αριθμητικό επίθημα (-1, -2, κ.λπ.) για να το κάνει μοναδικό.

Αυτό σας επιτρέπει να κάνετε πράγματα όπως να τοποθετήσετε ένα ## Δείγμα Ενότητας και στη συνέχεια να συνδεθείτε σε αυτό από άλλο σημείο του εγγράφου με έναν σύνδεσμο όπως (#sample-section) ή ακόμα και να συνδεθείτε σε ενότητες με ειδικούς χαρακτήρες στον τίτλο, καθώς το GitHub δημιουργεί το απόσπασμα ακολουθώντας αυτούς τους κανόνες και το καθιστά προσβάσιμο με το ίδιο μοτίβο.

Έμφαση, επισημασμένο κείμενο και παραθέματα

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

Για να κάνετε το κείμενο έντονο , περιβάλετέ το με διπλούς αστερίσκους ή διπλές υπογράμμισης. Για πλάγια γραφή, χρησιμοποιήστε μονούς αστερίσκους ή υπογράμμισης. Για διακριτή διαγραφή, χρησιμοποιήστε διπλή περισπωμένη (δύο περισπωμένες) εκατέρωθεν του κειμένου. Μπορείτε επίσης να συνδυάσετε ένθετη έντονη γραφή και πλάγια γραφή, να χρησιμοποιήσετε τρεις αστερίσκους για να εφαρμόσετε και τα δύο σε μια ολόκληρη ενότητα κειμένου ή να χρησιμοποιήσετε ετικέτες HTML όπως `<b>` _{για ^{δείκτες και εκθέτες και `<i>` για υπογράμμιση.}}

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

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

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

Επισήμανση κώδικα, μπλοκ και χρώματα

Τόσο το GitHub όσο και το Reddit σάς επιτρέπουν να επισημάνετε αποσπάσματα κώδικα μέσα σε κείμενο χρησιμοποιώντας backticks. Για ενσωματωμένο κώδικα, περικλείετε τη λέξη ή την εντολή με ένα μόνο backtick σε κάθε πλευρά. Αυτό είναι ιδανικό για την επισήμανση, για παράδειγμα, του ` git status` μέσα σε μια πρόταση, καθιστώντας σαφές ότι πρόκειται για εντολή.

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

Το GitHub προσφέρει επίσης μια συγκεκριμένη λειτουργία για την επισήμανση τιμών χρώματος μέσα σε backticks. Εάν πληκτρολογήσετε ένα χρώμα σε δεκαεξαδική, RGB ή HSL μορφή μεταξύ backticks, η πλατφόρμα περιλαμβάνει μια μικρή ένδειξη χρώματος δίπλα στο κείμενο. Για παράδειγμα, εάν το χρώμα φόντου σε ανοιχτόχρωμη λειτουργία είναι #ffffff και σε σκοτεινή λειτουργία είναι #000000, η ​​επισήμανση αυτών των κωδικών σάς επιτρέπει να δείτε γρήγορα ποιο είναι ποιο.

Όσον αφορά την εμφάνιση κώδικα και πίνακα, το GitHub σάς επιτρέπει να ενεργοποιήσετε μια σταθερή γραμματοσειρά monospace σε όλα τα πεδία σχολίων, διευκολύνοντας την εργασία με τεχνικό κείμενο. Εάν επεξεργάζεστε πολλά τμήματα κώδικα στο πρόγραμμα περιήγησής σας ή σε προγράμματα επεξεργασίας όπως το Visual Studio Code , η ενεργοποίηση αυτής της επιλογής κάνει την ευθυγράμμιση και την αναγνωσιμότητα πολύ πιο συνεπή.

Το Reddit υποστηρίζει επίσης μπλοκ κώδικα με backticks, τόσο inline όσο και block, αν και η χρήση τους εκεί επικεντρώνεται περισσότερο σε μικρά αποσπάσματα ή ψευδοκώδικα παρά σε μεγάλη τεκμηρίωση όπως αυτή ενός αποθετηρίου.

Σύνδεσμοι, άγκυρες και εσωτερική πλοήγηση

Η δημιουργία συνδέσμων στο Markdown είναι πολύ απλή: περικλείετε το κείμενο που θα εμφανίζεται στον χρήστη σε αγκύλες και τη διεύθυνση URL σε παρενθέσεις. Αυτό λειτουργεί τόσο στο GitHub όσο και στο Reddit και μπορεί να βελτιωθεί με συντομεύσεις πληκτρολογίου στο GitHub (για παράδειγμα, χρησιμοποιώντας συνδυασμούς πλήκτρων για γρήγορη μετατροπή επιλεγμένου κειμένου σε σύνδεσμο).

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

Ένας σχετικός σύνδεσμος είναι ένας σύνδεσμος που υπολογίζεται χρησιμοποιώντας το τρέχον αρχείο ως αναφορά. Για παράδειγμα, εάν το README σας βρίσκεται στη ρίζα του έργου και θέλετε να συνδεθείτε σε ένα αρχείο docs/CONTRIBUTING.md, απλώς γράφετε έναν σύνδεσμο με τη διαδρομή docs/CONTRIBUTING.md. Το GitHub χειρίζεται τη σωστή μετάφραση αυτού του σχετικού συνδέσμου σε οποιονδήποτε κλάδο στον οποίο βρίσκεστε, αποτρέποντάς τον από το να σπάσει κατά την εναλλαγή κλάδων ή την κλωνοποίηση του αποθετηρίου.

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

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

Εικόνες στο GitHub: Markdown, HTML και σχετικές διαδρομές

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

Οι εικόνες μπορούν να προέρχονται από αρχεία εντός του ίδιου του αποθετηρίου ή από εξωτερικές διευθύνσεις URL. Το GitHub επιτρέπει πολλαπλά μοτίβα σχετικής διαδρομής για την μεταφόρτωση εικόνων από διαφορετικά κλαδιά, άλλα αποθετήρια ή ακόμα και ζητήματα και σχόλια, χρησιμοποιώντας επιθήματα όπως ?raw=true για να επιβάλει μια άμεση λήψη αρχείου όταν είναι απαραίτητο.

Εκτός από την τυπική σύνταξη Markdown, το GitHub υποστηρίζει τη χρήση του στοιχείου HTML `<picture>`. Αυτό το στοιχείο είναι ιδιαίτερα χρήσιμο για τη φόρτωση εικόνων που προσαρμόζονται στις προτιμήσεις θέματος του χρήστη (ανοιχτό ή σκούρο). Χρησιμοποιώντας το ερώτημα πολυμέσων `prefers-color-scheme`, μπορείτε να ορίσετε διαφορετικές πηγές εικόνας για κάθε λειτουργία και μια προεπιλεγμένη εικόνα για προγράμματα περιήγησης που δεν υποστηρίζουν αυτήν τη λειτουργία.

Το τυπικό μοτίβο περιλαμβάνει την συμπερίληψη εντός πολλά στοιχεία με τα χαρακτηριστικά media και srcset, και τέλος ένα Χρησιμοποιώντας το χαρακτηριστικό alt και μια γενική διεύθυνση URL, οι χρήστες σε σκοτεινή λειτουργία βλέπουν μια προσαρμοσμένη εικόνα, ενώ όσοι βρίσκονται σε φωτεινή λειτουργία λαμβάνουν μια διαφορετική, χωρίς να χρειάζεται να αντιγράψουν περιεχόμενο στο αρχείο README.

Το GitHub υποστηρίζει επίσης σχόλια HTML σε αρχεία Markdown, επιτρέποντάς σας να προσθέσετε αόρατες υπενθυμίσεις στον αναγνώστη, για παράδειγμα για να του υπενθυμίσετε να ενημερώσει μια ενότητα εικόνας ή να προσθέσει νέα παραδείγματα αργότερα.

Πίνακες, πτυσσόμενα τμήματα και διαχωρισμός περιεχομένου

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

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

Για να διατηρήσετε οργανωμένο ένα μεγάλο αρχείο README, μπορείτε να χρησιμοποιήσετε την ετικέτα HTML `<details>` για να δημιουργήσετε πτυσσόμενες ενότητες. Αυτές οι ενότητες εμφανίζουν μια σύνοψη μέσα στην ετικέτα `<summary>` και επιτρέπουν στον χρήστη να αναπτύξει ή να συμπτύξει επιπλέον περιεχόμενο , όπως απαιτείται. Είναι συνήθης πρακτική να περικλείετε πίνακες ή μπλοκ δευτερευουσών πληροφοριών μέσα στο `<details>` για να αποφύγετε την καταπόνηση του χρήστη με την πρώτη ματιά.

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

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

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

Κρυφά σχόλια και έλεγχος μορφοποίησης

Το GitHub σάς επιτρέπει να εισάγετε σχόλια HTML μέσα στο Markdown χρησιμοποιώντας τη σύνταξη <!-- comment -->. Οτιδήποτε βάλετε μέσα σε αυτό το σχόλιο δεν θα εμφανίζεται στο περιεχόμενο που αποδίδεται, αλλά θα είναι ορατό στον πηγαίο κώδικα, καθιστώντας το ιδανικό για εσωτερικές σημειώσεις ή εκκρεμότητες.

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

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

Όταν προβάλλετε ένα αρχείο σήμανσης στο GitHub, έχετε την επιλογή να κάνετε εναλλαγή μεταξύ της προβολής που αποδίδεται και του πηγαίου κώδικα με ένα κουμπί στο επάνω μέρος (ή να το ανοίξετε σε προγράμματα επεξεργασίας όπως το Brackets ). Η απενεργοποίηση της ερμηνείας Markdown σάς επιτρέπει να έχετε πρόσβαση σε τυπικές λειτουργίες προβολής κώδικα, όπως η σύνδεση συγκεκριμένων γραμμών , κάτι που είναι πολύ χρήσιμο όταν θέλετε να επισημάνετε μια ακριβή ενότητα ενός αρχείου README ή οποιουδήποτε αρχείου .md.

Τέλος, να θυμάστε ότι το GitHub χειρίζεται τις αλλαγές γραμμής διαφορετικά στα σχόλια (προβλήματα, PRs, κ.λπ.) και στα αρχεία .md. Στα σχόλια, οι αλλαγές γραμμής γίνονται σεβαστές απευθείας, ενώ στα αρχεία Markdown πρέπει να προσθέσετε δύο κενά στο τέλος της γραμμής, μια ανάστροφη κάθετο ή μια τελεία. για να επιβάλετε το άλμα μέσα στην ίδια παράγραφο.

Λίστες, ένθετες λίστες και λίστες υποχρεώσεων

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

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

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

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

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

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

Αναφορές, αναφορές και emoji στο GitHub

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

Όταν πληκτρολογείτε το σύμβολο @, το GitHub εμφανίζει μια λίστα χρηστών και ομάδων που σχετίζονται με το αποθετήριο ή το νήμα και μπορείτε να φιλτράρετε αυτήν τη λίστα καθώς πληκτρολογείτε. Χρησιμοποιήστε τα πλήκτρα βέλους και πατήστε Enter ή Tab για να αποδεχτείτε τις προτάσεις. Για ομάδες, χρησιμοποιήστε τη μορφή @organization/team-name και όλα τα μέλη της ομάδας θα εγγραφούν στο νήμα.

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

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

Τέλος, το GitHub υποστηρίζει emoji μέσω κώδικα: πληκτρολογήστε μια άνω και κάτω τελεία, ακολουθούμενη από το όνομα του emoji και ολοκληρώστε με μια άλλη άνω και κάτω τελεία. Καθώς αρχίζετε να πληκτρολογείτε, εμφανίζεται μια λίστα με προτάσεις, τις οποίες μπορείτε να αποδεχτείτε με Tab ή Enter. Η ενσωμάτωση emoji στα σχόλιά σας βοηθά να τους δώσετε μια πιο ανθρώπινη πινελιά, αρκεί να μην τα χρησιμοποιείτε υπερβολικά στην επίσημη τεκμηρίωση.

Υποσημειώσεις και προηγμένο περιεχόμενο

Το GitHub υποστηρίζει επίσης υποσημειώσεις χρησιμοποιώντας μια σύνταξη που βασίζεται σε αγκύλες και ένα αναγνωριστικό με χαρακτήρα caret. Στο σημείο όπου θέλετε την αναφορά, εισάγετε κάτι όπως `<footnote>` και στο τέλος του εγγράφου, ορίζετε το κείμενο αυτής της υποσημείωσης με την ίδια ετικέτα, ακολουθούμενο από άνω και κάτω τελεία και το περιεχόμενο.

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

Μια άλλη προηγμένη λειτουργία που προσφέρεται από το GitHub είναι οι προαναφερθείσες ειδοποιήσεις (ΣΗΜΕΙΩΣΗ, ΣΥΜΒΟΥΛΗ, ΣΗΜΑΝΤΙΚΟ, ΠΡΟΕΙΔΟΠΟΙΗΣΗ και ΠΡΟΣΟΧΗ). Συνιστάται να τις χρησιμοποιείτε μόνο όταν είναι πραγματικά απαραίτητο και να αποφεύγετε την αλυσιδωτή σύνδεση πολλών ειδοποιήσεων μεταξύ τους για να μην κατακλύζετε τον αναγνώστη. Δεν μπορούν να ενσωματωθούν σε άλλα σύνθετα στοιχεία, επομένως είναι απαραίτητος ο προσεκτικός σχεδιασμός για την τοποθέτησή τους.

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

Markdown στο Reddit: Snoomark και λειτουργία επεξεργασίας

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

Από προεπιλογή, το Reddit συνήθως ενεργοποιεί τον επεξεργαστή εμπλουτισμένου κειμένου, επομένως για να μεταβείτε στη λειτουργία σήμανσης, πρέπει να κάνετε κλικ στην επιλογή Λειτουργία Markdown μέσα στο πλαίσιο κειμένου μιας ανάρτησης ή σχολίου. Από εκεί, μπορείτε να χρησιμοποιήσετε απευθείας τη σύνταξη του Snoomark.

Αν προτιμάτε να φορτώνει πάντα ο επεξεργαστής Markdown, μεταβείτε στις ρυθμίσεις χρήστη, μεταβείτε στην ενότητα Ρυθμίσεις ροής και ενεργοποιήστε την επιλογή "Προεπιλογή σε Markdown" . Με αυτόν τον τρόπο, ο επεξεργαστής Markdown θα ανοίγει αυτόματα κάθε φορά που ξεκινάτε να γράφετε μια ανάρτηση ή σχόλιο, χωρίς να χρειάζεται να το αλλάξετε χειροκίνητα.

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

Σύνταξη που υποστηρίζεται από το Reddit και spoilers

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

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

Το Reddit, από την άλλη πλευρά, προσθέτει επιπλέον λειτουργίες που δεν περιλαμβάνονται στις τυπικές προδιαγραφές, όπως spoilers. Αυτά επιτρέπουν την απόκρυψη κειμένου πίσω από ένα επίπεδο που ο χρήστης μπορεί να αποκαλύψει με ένα κλικ. Τεχνικά, όταν το Reddit επεξεργάζεται ένα spoiler, το μετατρέπει σε έναν συνδυασμό HTML, κλάσεων CSS και JavaScript ειδικής πλατφόρμας.

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

Εν ολίγοις, το Snoomark κληρονομεί πολλές συμπεριφορές από το GitHub Flavored Markdown, αλλά προσανατολίζεται στις ανάγκες μιας κοινότητας συζήτησης και όχι στην τεκμηρίωση του έργου. Παρόλα αυτά, ο πυρήνας παραμένει ο ίδιος: απλό κείμενο με απλά σύμβολα που μετατρέπονται σε δομημένο και ευανάγνωστο περιεχόμενο.

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