Η online προεπισκόπηση Markdown και μια τοπική έκδοση εγγράφων απαντούν σε διαφορετικές ερωτήσεις. Μια διαδικτυακή προεπισκόπηση ρωτά: "Αυτό το Markdown αποδίδεται καθαρά σε μια γενική προεπισκόπηση και υπάρχουν προφανή ζητήματα σύνταξης;" Μια τοπική έκδοση εγγράφων ρωτά: "Λειτουργεί αυτό το περιεχόμενο μέσα στο πραγματικό μας σύστημα τεκμηρίωσης;"
Και τα δύο είναι χρήσιμα. Το λάθος είναι ότι ζητάμε από το ένα στρώμα να κάνει τη δουλειά του άλλου στρώματος. Το Markdown Validator της Converty είναι ένας γρήγορος έλεγχος από νωρίς. Η τοπική έκδοση των εγγράφων σας παραμένει ο τελικός έλεγχος περιβάλλοντος όταν έχει σημασία η απόδοση για συγκεκριμένη πλατφόρμα.
Χρησιμοποιήστε διαδικτυακή προεπισκόπηση για γρήγορη αναθεώρηση προχείρων
Μια διαδικτυακή προεπισκόπηση Markdown είναι χρήσιμη όταν το περιεχόμενο εξακολουθεί να κινείται. Μια ενότητα README, μια σημείωση έκδοσης, η καταχώρηση αρχείου καταγραφής αλλαγών ή ένα έγγραφο υποστήριξης μπορεί να ελεγχθεί πριν γίνει αίτημα έλξης ή έκδοση εγγράφων.
Η προεπισκόπηση βοηθά στη σύλληψη:
- σπασμένα τραπέζια
- ζητήματα δομής επικεφαλίδας
- λείπει εναλλακτικό κείμενο
- κενοί σύνδεσμοι
- φράχτες χωρίς ετικέτα
- ακατέργαστο HTML που χρειάζεται έλεγχο
Αυτό είναι το στάδιο όπου η γρήγορη ανάδραση έχει μεγαλύτερη σημασία από την πλήρη ακρίβεια περιβάλλοντος.
Χρησιμοποιήστε μια τοπική έκδοση εγγράφων για την τελική απόδοση
Μια τοπική έκδοση εγγράφων είναι το σωστό επίπεδο όταν η τελική πλατφόρμα έχει προσαρμοσμένη συμπεριφορά. Πολλά συστήματα εγγράφων μεταμορφώνουν το Markdown μέσω στοιχείων, δρομολόγησης, επισήμανσης σύνταξης, προσαρμοσμένων μηνυμάτων προώθησης ή στυλ συγκεκριμένου πλαισίου.
Μόνο η τοπική έκδοση μπορεί να δείξει εάν το περιεχόμενο λειτουργεί σε αυτό το περιβάλλον. Εάν μια σελίδα χρησιμοποιεί προσαρμοσμένα στοιχεία, εισαγόμενα αποσπάσματα ή απόδοση για συγκεκριμένο προϊόν, η προεπισκόπηση του προγράμματος περιήγησης θα πρέπει να είναι πρώτη και όχι τελευταία.
Η καλύτερη ροή εργασίας χρησιμοποιεί και τα δύο
Χρησιμοποιήστε online προεπισκόπηση για να καθαρίσετε την πηγή. Χρησιμοποιήστε την τοπική κατασκευή για να επαληθεύσετε τον προορισμό.
Αυτή η ακολουθία εξοικονομεί χρόνο επειδή η τοπική κατασκευή δεν καταγράφει πλέον βασικά λάθη Markdown. Μπορεί να επικεντρωθεί στη συμπεριφορά της συγκεκριμένης πλατφόρμας που είναι μοναδικά σε θέση να δοκιμάσει.
Για μια πρακτική ροή εργασίας πρώιμου ελέγχου, διαβάστε το Πώς να κάνετε προεπισκόπηση του GitHub-Flavored Markdown Πριν το δεσμεύσετε. Για παραδόσεις προϊόντων και εγγράφων, διαβάστε το Πώς οι ομάδες προϊόντων και εγγράφων μπορούν να ελέγξουν τη σημείωση χωρίς απώλεια μορφοποίησης.
Ανοίξτε το Markdown Validator όταν χρειάζεστε το γρήγορο επίπεδο προεπισκόπησης στο διαδίκτυο πριν μετακινήσετε το ίδιο περιεχόμενο σε μια έκδοση τοπικών εγγράφων ή τελική προεπισκόπηση δημοσίευσης.
