Aflați Markdown: Instrumentul de scriere pentru dezvoltatorii de software

Dacă sunteți inginer de software, probabil că ați petrecut mult timp rafinându-vă mediul pentru a vă crește productivitatea. Ai IDE-ul tău preferat. Ai depanatorul tău preferat. Ai instrumentul tău preferat de monitorizare a performanței. Dar cum rămâne cu instrumentul tău pentru scrierea documentației, a manualelor și a rapoartelor? La urma urmei, scrisul îți ia o cantitate non-trivială din timpul tău, nu-i așa? Într-adevăr, este timpul să iei în serios instrumentul tău de scris.

Și să ne amintim că ești tehnic , așa că editorii WYSIWYG pot fi sau nu cea mai bună opțiune pentru tine. Nu doriți (sau măcar să vă place!) să navigați în meniuri, bare de instrumente și panglici pentru a vă forma textul.

Deci, ce se întâmplă dacă, în schimb, ați putea adăuga cu ușurință toate stilurile de formatare direct în text ca o simplă sintaxă inline pentru a obține text complet formatat?

Ei bine, de fapt, poți. Acesta este Markdown și despre asta se referă acest tutorial.

Când mai mult este mai puțin...

Software-ul de procesare a textului este scris pentru a satisface o gamă extrem de largă de utilizatori și cazuri de utilizare și, ca atare, trebuie să ofere tot felul de funcționalități. Dar în mod clar, doar un mic subset al acestei funcționalități este probabil să fie relevant pentru fiecare utilizator individual. Iar pentru majoritatea utilizatorilor, care doresc pur și simplu să creeze un document (și nu au nevoie să creeze o broșură de marketing sau un poster), un subset foarte mic din multe, multe opțiuni disponibile sunt relevante.

De fapt, Microsoft și-a dat seama clar de acest lucru cu câțiva ani în urmă, când a reproiectat interfața cu utilizatorul Microsoft Word în grupări funcționale distincte pe care le-au numit „panglici”. Cu toate acestea, în mod interesant, majoritatea utilizatorilor vă vor spune că noua interfață le-a găsit mai confuză și mai dificil de navigat decât predecesorul ei.

Într-adevăr, mai mult poate fi uneori mai puțin atunci când vine vorba de ușurință în utilizare și productivitate.

… și Când mai puțin este mai mult

Înțeleg, ești inginer software, nu grafician. Vrei doar să scrii acel manual, sau documentul tehnic, sau raportul și să termini cu el. Veți fi foarte mulțumit și mulțumit de unele capabilități de formatare de bază, cum ar fi titluri, liste cu marcatori sau numerotate și blocuri de cod. Și, oh, da, unele formatări ale fonturilor (aldine, cursive etc.) ar fi de asemenea utilă. Cam atât. (Și omule, dacă ai putea să o faci în vi, ar fi cu adevărat minunat!)

Introduceți Markdown.

Ce este Markdown?

John Gruber (cu contribuții substanțiale de la guru tehnic și activist pe internet Aaron Swartz) a creat limbajul Markdown în 2004 cu scopul de a permite oamenilor „să scrie folosind un format de text simplu ușor de citit, ușor de scris și, opțional, convertiți-l în XHTML (sau HTML) valid structural”.

Markdown a fost conceput pentru a fi citit așa cum este, fără să arate ca a fost marcat cu etichete sau instrucțiuni de formatare (spre deosebire de textul formatat cu un limbaj de marcare precum RTF sau HTML, care poate fi atât greu de scris, cât și greu de citit în formatul său brut. ).

Markdown vă permite să scrieți folosind un format de text simplu ușor de citit, ușor de scris, care poate fi apoi convertit în HTML valid din punct de vedere structural. Deci, pentru a fi complet precis, Markdown este de fapt două lucruri:

1. O sintaxă de formatare a textului simplu
2. Un instrument software (a cărui primă versiune a fost scrisă în Perl) care convertește formatarea textului simplu în HTML.

Markdown încorporează o mână de convenții de sintaxă simple, destul de intuitive și ușor de utilizat. Mai ales pentru tine ca inginer de software – care nu este descurajat de nevoia de a învăța și de a folosi aceste convenții de sintaxă de bază – Markdown poate fi într-adevăr calea cu cea mai mică rezistență între ceea ce vrei să scrii și să-l scrii.

Aflați Markdown: Noțiuni introductive

Markdown este ușor de învățat. Super usor. Puteți învăța elementele de bază în cinci minute și va deveni rapid a doua natură. Și – la fel ca relația dintre CSS și preprocesoarele CSS – puteți folosi cât de puțin sau cât doriți.

Dacă sunteți obișnuit cu orice fel de convenții de scriere a textului simplu, atunci s-ar putea să fiți deja familiarizați cu unele convenții de reducere, cum ar fi numere sau liniuțe de la începutul unei propoziții pentru a crea o listă, asteriscuri în jurul unui cuvânt pentru a sublinia și așadar. pe. Deci, de exemplu, dacă doriți să afișați ceva cu caractere cursive, pur și simplu înfășurați-l în asteriscuri ca *this* (spre deosebire de sintaxa HTML mai greoaie ca <span>this</span> ).

În mod similar, puteți specifica un titlu H1 adăugând pur și simplu un prefix „#” la linia dvs. (de exemplu, # Section Heading , mai degrabă decât <h1>Section Heading</h1> ).

O altă utilizare excelentă pentru a învăța Markdown, în special pentru noi, inginerii de software, este folosirea acestuia pentru documentația privind depozitele de cod sursă. Majoritatea repozițiilor includ un fișier README.md ( .md este extensia standard pentru un fișier Markdown). Github, de exemplu, are propriul „Markdown cu aromă de Github”, care adaugă funcționalități suplimentare special pentru documentația de dezvoltare. Acest lucru poate economisi timp cu siguranță că trebuie să scrieți această documentație în HTML.

Ca exemplu simplu, să presupunem că doriți să includeți următorul fragment în documentația dvs.:

<h2 style=color:#3863a0;font-size:1.5em;font-weight:600;margin-top:2em;margin-bottom:1em;line-height:1.3em;>Inițierea pluginurilor</h2>

Inițiază pluginName pe container folosind jQuery după cum urmează:

$(function() { $('#container').pluginName(); }); Folosind ID-ul containerului nostru, putem iniția pluginName cu metoda jQuery .pluginName() .

Iată o comparație a modului în care s-ar face acest lucru în HTML și Markdown:

Pentru ajutor suplimentar la început, există multe tutoriale Markdown online pentru a vă ajuta să vă actualizați la viteză, inclusiv o prezentare generală Markdown de John Gruber (creatorul Markdown), precum și un tutorial online Markdown.

Analizoare și instrumente Markdown

După ce ați scris articolul în Markdown, veți avea nevoie de o aplicație pentru a analiza sintaxa în HTML. Există câteva grozave care sunt gratuite , inclusiv:

• StackEdit - editor Markdown bazat pe browser care are câteva opțiuni de sincronizare cu servicii populare precum Google Drive și Dropbox
• Online Kramdown Editor - un alt editor Markdown bazat pe browser, cu o interfață extrem de simplă
• Mou - cel mai bun scriitor Markdown bazat pe Mac pe care l-am întâlnit ca o opțiune mai geek pentru dezvoltatori; tone de funcții și gratuit (în timpul beta) [acesta este ceea ce am folosit pentru a scrie acest articol]
• MarkdownPad - editor Markdown excelent pentru Windows
• Texte - un editor frumos multiplatform (Mac și Windows); exportă în mai multe formate, cum ar fi PDF, .doc și ePub

Unele platforme majore au adoptat deja (sau cel puțin au permis) utilizarea Markdown în editorii lor pentru cei care doresc să-l folosească. Cu altele, cum ar fi WordPress, Evernote și Google Docs, suportul nativ (la momentul scrierii acestui articol) nu este încă integrat, dar soluții personalizate au fost introduse de terți. Acestea includ:

• Noua platformă populară de blogging Ghost, în căutarea simplificării scrisului online, folosește Markdown pentru editorul său de conținut.
• Pentru WordPress, pluginul Jetpack acceptă acum oficial Markdown, pe care îl puteți activa în Setări > Discuție dacă utilizați pluginul. Sau puteți folosi un plugin precum WP-Markdown, care va converti conținutul post markdown în HTML și înapoi la Markdown atunci când trebuie să îl editați.
• Pentru Evernote, unele aplicații Markdown, cum ar fi editorul online Markable sau editorul Mac Byword, permit exportul și publicarea direct în note. Sau dacă preferați să utilizați aplicația web Evernote direct, puteți utiliza o extensie de browser numită Markdown Here, care convertește o notă selectată scrisă în Markdown în text formatat cu un clic pe butonul din bara de instrumente.
• Google Docs nu acceptă în mod nativ Markdown încă, dar câțiva editori (cum ar fi StackEdit) vor exporta/sincroniza direct cu Drive.

Dezavantajele

Desigur, cu o mare simplitate vin și limitări. După cum am explicat deja, Markdown nu a fost scris pentru sarcini complexe de procesare a textului care necesită funcții avansate de formatare. Dacă de asta aveți nevoie, Markdown nu este instrumentul potrivit.

Dar pentru dezvoltatorii care trebuie să scrie un manual de utilizare sau o documentație tehnică sau un raport tehnic, Markdown oferă un echilibru aproape perfect între simplitate și caracteristicile de care aveți nevoie.

Poate cel mai mare dezavantaj – în special pentru noi, inginerii, care suntem îndrăgostiți de controlul schimbărilor – este incapacitatea de a lucra în colaborare în Markdown și de a urmări modificările (o excepție notabilă de la aceasta, totuși, este pluginul StackEdit pentru Google Docs). Și, desigur, cu un efort minim, puteți colabora pur și simplu la un document Markdown printr-un depozit git și, prin urmare, puteți obține toate urmărirea modificărilor și colaborarea de care aveți nevoie de obicei.

Concluzie

Deci, învățarea Markdown este pentru toată lumea? Desigur că nu. Nicio unealtă nu există vreodată.

Dar dacă ești inginer software, ar putea foarte bine să fie tocmai instrumentul de scriere pe care l-ai căutat. Așa că, dacă nu l-ați încercat încă, ar trebui să o faceți o învârtire.