Τεχνολογία

Μάθετε Markdown: Το Εργαλείο γραφής για προγραμματιστές λογισμικού



Εάν είστε μηχανικός λογισμικού , πιθανότατα ξοδέψατε πολύ χρόνο για να βελτιώσετε το περιβάλλον σας για να αυξήσετε την παραγωγικότητά σας. Έχετε το αγαπημένο σας IDE. Έχετε το αγαπημένο σας πρόγραμμα εντοπισμού σφαλμάτων. Έχετε το αγαπημένο σας εργαλείο παρακολούθησης απόδοσης. Τι γίνεται όμως με το εργαλείο σας για τη σύνταξη τεκμηρίωσης, εγχειριδίων και αναφορών; Μετά από όλα, το γράψιμο παίρνει ένα ασήμαντο ποσό του χρόνου σας, έτσι δεν είναι; Πράγματι, ήρθε η ώρα να ασχοληθείτε σοβαρά με το εργαλείο γραφής σας.

Και ας το θυμόμαστε αυτό είσαι τεχνικός , επομένως οι συντάκτες WYSIWYG μπορεί ή όχι να είναι η καλύτερη επιλογή για εσάς. Δεν θέλετε απαραίτητα (ή ακόμη και να σας αρέσουν!) Τα μενού πλοήγησης, γραμμές εργαλείων και κορδέλες να μορφοποιήσουν το κείμενό σας.



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



Λοιπόν, στην πραγματικότητα, μπορείτε. Αυτό είναι Χαμήλωση τιμής και αυτό είναι το σεμινάριο.



Όταν περισσότερα είναι λιγότερα…

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

Στην πραγματικότητα, η Microsoft το συνειδητοποίησε ξεκάθαρα πριν από λίγα χρόνια, όταν επανασχεδίασαν τη διεπαφή χρήστη του Microsoft Word σε ξεχωριστές λειτουργικές ομάδες που ονόμαζαν «κορδέλες». Ωστόσο, είναι ενδιαφέρον ότι οι περισσότεροι χρήστες θα σας πουν ότι βρήκαν τη νέα διεπαφή πιο συγκεχυμένη και δύσκολη στην πλοήγηση από τον προκάτοχό της.



βρετανική εταιρεία τραπεζικών και χρηματοοικονομικών υπηρεσιών

μάθετε markdown

Πράγματι, περισσότερα μπορεί μερικές φορές να είναι λιγότερα όταν πρόκειται για ευκολία χρήσης και παραγωγικότητας.



… Και όταν το λιγότερο είναι περισσότερο

Αντιμετωπίστε το, είστε μηχανικός λογισμικού και όχι γραφίστας. Θέλετε απλώς να γράψετε αυτό το εγχειρίδιο ή τεχνικό έγγραφο ή αναφορά και να το ολοκληρώσετε. Θα είστε πολύ χαρούμενοι και ικανοποιημένοι με ορισμένες βασικές δυνατότητες μορφοποίησης, όπως επικεφαλίδες, λίστες με κουκκίδες ή αριθμούς και μπλοκ κώδικα. Και, ω ναι, κάποια μορφοποίηση γραμματοσειρών (έντονη γραφή, πλάγια γραφή κ.λπ.) θα ήταν επίσης χρήσιμη. Για αυτό πρόκειται. (Και φίλε, αν μπορούσες να το κάνεις εμείς , θα ήταν πραγματικά φοβερό!)

Εισαγάγετε Markdown.



Τι είναι το Markdown;

Τζον Γκρουμπρ (με σημαντικές συνεισφορές από τεχνικό γκουρού και ακτιβιστή στο Διαδίκτυο Aaron Swartz ) δημιούργησε τη γλώσσα Markdown το 2004 με ο στόχος της δυνατότητας των ατόμων «να γράφουν χρησιμοποιώντας μια ευανάγνωστη, ευανάγνωστη μορφή απλού κειμένου και προαιρετικά να την μετατρέπουν σε δομικά έγκυρο XHTML (ή HTML)».



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

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



  1. Μια σύνταξη μορφοποίησης απλού κειμένου
  2. Ένα εργαλείο λογισμικού (η πρώτη έκδοση του οποίου γράφτηκε σε Perl) που μετατρέπει τη μορφοποίηση απλού κειμένου σε HTML.

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

συμβάσεις σύνταξης markdown

Μάθετε Markdown: Ξεκινώντας

Το Markdown είναι εύκολο να μάθει. Πολύ εύκολο. Μπορείτε να μάθετε τα βασικά σε πέντε λεπτά και θα γίνει γρήγορα δεύτερη φύση. Και - όπως ακριβώς και η σχέση μεταξύ των προεπεξεργαστών CSS και CSS - μπορείτε να χρησιμοποιήσετε όσο λίγα ή όσο θέλετε.

Εάν έχετε συνηθίσει σε οποιοδήποτε είδος συμβάσεων γραφής απλού κειμένου, τότε ίσως να είστε ήδη εξοικειωμένοι με ορισμένες συμβάσεις markdown, όπως αριθμούς ή παύλες στην αρχή μιας πρότασης για να δημιουργήσετε μια λίστα, αστερίσκους γύρω από μια λέξη για έμφαση και ούτω καθεξής επί. Έτσι, για παράδειγμα, εάν θέλετε να εμφανίσετε κάτι με πλάγια γράμματα, απλώς τυλίξτε το με αστερίσκους όπως *this* (σε αντίθεση με τη σύνταξη HTML clunkier όπως this).

ορισμός της τέχνης και του σχεδίου

Ομοίως, μπορείτε να καθορίσετε μια επικεφαλίδα H1 προσθέτοντας απλώς ένα πρόθεμα '#' στη γραμμή σας (π.χ. # Section Heading, αντί για # Initiating Plugins

Initiate pluginName στο κοντέινερ σας χρησιμοποιώντας το jQuery ως εξής:

Ξεκινήστε το «pluginName» στο κοντέινερ σας χρησιμοποιώντας το jQuery ως εξής:
$(function() { $('#container').pluginName(); });
$ (function () {$ ('# container'). pluginName ();}); '

Χρησιμοποιώντας το αναγνωριστικό του κοντέινερ, μπορούμε να ξεκινήσουμε pluginName με τη μέθοδο jQuery .pluginName()

* Χρησιμοποιώντας το αναγνωριστικό του κοντέινερ, μπορούμε να ξεκινήσουμε το 'pluginName' με τη μέθοδο jQuery '.pluginName ()'. *

Για περισσότερη βοήθεια για να ξεκινήσετε, υπάρχουν πολλά σεμινάρια Markdown στο διαδίκτυο για να σας βοηθήσουν να φτάσετε στην ταχύτητα, συμπεριλαμβανομένου ενός Επισκόπηση επισήμανσης από τον John Gruber (δημιουργός του Markdown) καθώς και από ένα διαδικτυακό Σεμινάριο Markdown .

Αναλυτές και εργαλεία Markdown

Μόλις γράψετε το άρθρο σας στο Markdown, θα χρειαστείτε μια εφαρμογή για να αναλύσετε τη σύνταξη σε HTML. Υπάρχουν μερικά υπέροχα Ελεύθερος συμπεριλαμβανομένου:

  • StackEdit - Πρόγραμμα επεξεργασίας Markdown βάσει προγράμματος περιήγησης που έχει μερικές επιλογές συγχρονισμού με δημοφιλείς υπηρεσίες όπως το Google Drive και το Dropbox
  • Online Kramdown Editor - Ένας άλλος επεξεργαστής Markdown που βασίζεται στο πρόγραμμα περιήγησης με εξαιρετικά απλή διεπαφή
  • Mou - ο καλύτερος συγγραφέας Markdown που βασίζεται σε Mac και έχω συναντήσει ως επιλογή geekier για προγραμματιστές. τόνοι δυνατοτήτων και δωρεάν (ενώ σε beta) [αυτό έγραψα αυτό το άρθρο]
  • MarkdownPad - υπέροχος επεξεργαστής Markdown για Windows
  • Κείμενα - ένα ωραίο πρόγραμμα επεξεργασίας πολλαπλών πλατφορμών (Mac και Windows). εξάγει σε πολλές μορφές όπως PDF, .doc και ePub

Ορισμένες μεγάλες πλατφόρμες έχουν ήδη υιοθετήσει (ή τουλάχιστον επιτρέπεται) χρήση Markdown στους συντάκτες τους για όσους επιθυμούν να τη χρησιμοποιήσουν. Με άλλους, όπως το WordPress, το Evernote και τα Έγγραφα Google, η εγγενής υποστήριξη (τη στιγμή της σύνταξης αυτού του άρθρου) δεν έχει ακόμη ολοκληρωθεί, αλλά έχουν εισαχθεί προσαρμοσμένες λύσεις από τρίτους. Αυτά περιλαμβάνουν:

  • Δημοφιλής νέα πλατφόρμα blogging Φάντασμα , στην προσπάθεια βελτιστοποίησης της διαδικτυακής γραφής, χρησιμοποιεί το Markdown για το πρόγραμμα επεξεργασίας περιεχομένου.
  • Για το WordPress, το πρόσθετο Jetpack υποστηρίζει επίσημα το Markdown, το οποίο μπορείτε να ενεργοποιήσετε κάτω Ρυθμίσεις> Συζήτηση εάν χρησιμοποιείτε την προσθήκη. Ή θα μπορούσατε να χρησιμοποιήσετε μια προσθήκη WP-Markdown το οποίο θα μετατρέψει το περιεχόμενο μετά την υπογραφή σε HTML και θα επιστρέψει σε Markdown όταν πρέπει να το επεξεργαστείτε.
  • Για το Evernote, ορισμένες εφαρμογές Markdown όπως ένας διαδικτυακός επεξεργαστής Αξιοσημείωτο ή το πρόγραμμα επεξεργασίας Mac Παρατσούκλι επιτρέψτε την εξαγωγή και δημοσίευση απευθείας σε σημειώσεις. Εναλλακτικά, εάν προτιμάτε να χρησιμοποιείτε απευθείας την εφαρμογή web Evernote, μπορείτε να χρησιμοποιήσετε μια επέκταση προγράμματος περιήγησης που ονομάζεται Σημειώστε εδώ που μετατρέπει μια επιλεγμένη σημείωση γραμμένη σε Markdown σε μορφοποιημένο κείμενο με ένα κλικ στο κουμπί της γραμμής εργαλείων.
  • Τα Έγγραφα Google δεν υποστηρίζουν εγγενώς το Markdown, αλλά μερικοί συντάκτες (όπως StackEdit ) θα εξάγει / συγχρονίζει απευθείας με το Drive.

Τα μειονεκτήματα

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

μάθετε τη γλώσσα c για αρχάριους

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

Ίσως το μεγαλύτερο μειονέκτημα - ειδικά για εμάς μηχανικούς που είναι λάτρεις του ελέγχου αλλαγών - είναι η αδυναμία να το κάνουμε συνεργαστείτε στο Markdown και για την παρακολούθηση αλλαγών (μια αξιοσημείωτη εξαίρεση σε αυτό, ωστόσο, είναι το StackEdit προσθήκη για τα Έγγραφα Google). Και φυσικά, με ελάχιστη προσπάθεια, κάποιος μπορεί απλά να συνεργαστεί σε ένα έγγραφο Markdown μέσω ενός αποθετηρίου git και έτσι να πάρει όλη την παρακολούθηση αλλαγών και τη συνεργασία που συνήθως χρειάζεται κάποιος.

συμπέρασμα

Έτσι, μαθαίνει το Markdown για όλους; Φυσικά και όχι. Κανένα εργαλείο δεν είναι ποτέ.

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

Πώς να δημιουργήσετε προσαρμοσμένα widget Magento 2

Πίσω Μέρος

Πώς να δημιουργήσετε προσαρμοσμένα widget Magento 2
iOS 9 Betas και WatchOS 2 για προγραμματιστές

iOS 9 Betas και WatchOS 2 για προγραμματιστές

Κινητό