Teknologia

Learn Markdown: Kirjoitustyökalu ohjelmistokehittäjille

Jos olet ohjelmistoinsinööri , olet todennäköisesti viettänyt paljon aikaa ympäristön parantamiseen tuottavuuden parantamiseksi. Sinulla on suosikki IDE. Sinulla on suosikki virheenkorjausohjelma. Sinulla on suosikkisi suorituskyvyn seurantatyökalu. Mutta entä työkalu dokumentaation, käsikirjojen ja raporttien kirjoittamiseen? Loppujen lopuksi kirjoittaminen vie ei-triviaalia aikaa, eikö niin? Itse asiassa on aika suhtautua vakavasti kirjoitustyökaluun.

Ja muistetaan se olet tekninen , joten WYSIWYG-toimittajat eivät välttämättä ole paras vaihtoehto sinulle. Et välttämättä halua (tai edes tykkää!) Navigoiminen valikoissa, työkaluriveissä ja nauhoissa muotoillaksesi tekstiä.

Joten mitä jos sen sijaan voit helposti lisätä kaikki muotoilutyylisi suoraan tekstiin yksinkertaisena sisäisenä syntaksina, jotta saat täysin muotoillun tekstin?



No, itse asiassa voit. Se on Markdown ja siitä tässä opetusohjelmassa on kyse.

Kun enemmän on vähemmän…

Tekstinkäsittelyohjelmisto on kirjoitettu tyydyttämään erittäin laaja joukko käyttäjiä ja käyttötapauksia, ja sellaisenaan sen on tarjottava kaikenlaisia ​​toimintoja. Mutta selvästi, vain pieni osa toiminnallisuudesta on todennäköisesti merkityksellistä jokaiselle yksittäiselle käyttäjälle. Ja useimmille käyttäjille, jotka haluavat yksinkertaisesti kirjoittaa asiakirjan (ja joiden ei tarvitse suunnitella markkinointiesitteitä tai julisteita), hyvin pieni joukko käytettävissä olevista monista, monista vaihtoehdoista on merkityksellistä.

Itse asiassa Microsoft tajusi tämän selvästi muutama vuosi sitten, kun he suunnittelivat Microsoft Wordin käyttöliittymän erillisiksi toiminnallisiksi ryhmiksi, joita he kutsuivat 'nauhoiksi'. Silti mielenkiintoista on, että useimmat käyttäjät kertovat sinulle, että heidän mielestään uusi käyttöliittymä oli hämmentävämpi ja vaikeampi navigoida kuin edeltäjänsä.

oppia markdown

Itse asiassa enemmän voi joskus olla vähemmän, kun on kyse helppokäyttöisyydestä ja tuottavuudesta.

… Ja kun vähemmän on enemmän

Tunnustakaa, että olet ohjelmistosuunnittelija, et graafinen suunnittelija. Haluat vain kirjoittaa käsikirjan tai teknisen asiakirjan tai raportin ja tehdä sen. Olet erittäin tyytyväinen ja tyytyväinen joihinkin perusmuotoiluominaisuuksiin, kuten otsikoihin, luettelomerkkeihin tai numeroituihin luetteloihin ja koodilohkoihin. Ja, joo, joistakin fonttien muotoilusta (lihavoitu, kursivointi jne.) Olisi myös hyödyllistä. Siinäpä se. (Ja mies, jos voisit edes tehdä sen vain sisään me , se olisi todella mahtavaa!)

Syötä Markdown.

Mikä on Markdown?

John Gruber (merkittävällä panoksella tekniseltä gurulta ja Internet-aktivistilta Aaron Swartz ) loi Markdown-kielen vuonna 2004 maali antaa ihmisille mahdollisuuden 'kirjoittaa helposti luettavalla, helposti kirjoitettavalla pelkällä tekstimuodolla ja muuntaa se rakenteellisesti päteväksi XHTML: ksi (tai HTML: ksi)'.

Markdown on suunniteltu luettavaksi sellaisenaan, ilman että se olisi merkitty tunnisteilla tai muotoiluohjeilla (toisin kuin teksti, joka on muotoiltu merkintäkielellä, kuten RTF tai HTML, joka voi olla sekä vaikea laatia että vaikea lukea raakamuodossaan ).

Markdownin avulla voit kirjoittaa helposti luettavalla, helposti kirjoitettavalla tekstimuodolla, joka voidaan sitten muuntaa rakenteellisesti päteväksi HTML: ksi. Joten, ollakseni täysin tarkka, Markdown on oikeastaan ​​kaksi asiaa :

  1. Pelkän tekstin muotoilun syntakse
  2. Ohjelmistotyökalu (jonka ensimmäinen versio kirjoitettiin Perlissä), joka muuntaa pelkkän tekstin muotoilun HTML-muotoon.

Markdown sisältää kourallisen yksinkertaisia, melko intuitiivisia ja helppokäyttöisiä syntaksikäytäntöjä. Erityisesti sinulle ohjelmistosuunnittelijana - jota ei pidä lykätä tarvitsemalla oppia ja käyttämään näitä perussyntaksi-käytäntöjä - Markdown voi todellakin olla vähiten vastustuskykyinen kirjoittamasi teksti ja kirjoittaminen.

markdown-syntaksikäytännöt

Opi Markdown: Aloittaminen

Markdown on helppo oppia. Erittäin helppoa. Voit oppia perusasiat viidessä minuutissa, ja siitä tulee nopeasti toinen luonne. Ja aivan kuten CSS: n ja CSS-esiprosessoreiden suhde, voit käyttää niin vähän tai niin paljon kuin haluat.

Jos olet tottunut minkäänlaisiin pelkkien tekstien kirjoittamisen käytäntöihin, saatat olla jo perehtynyt joihinkin merkintäkäytäntöihin, kuten lauseen alussa oleviin numeroihin tai viivoihin luettelon luomiseksi, tähtimerkit sanan ympärille korostettaviksi ja niin edelleen päällä. Joten esimerkiksi, jos haluat näyttää jotain kursiivilla, yksinkertaisesti kääri se tähtiin kuten *this* (toisin kuin clunkier HTML-syntaksissa, kuten this).

Vastaavasti voit määrittää H1-otsikon yksinkertaisesti lisäämällä riville '#' -etuliitteen (esim. # Section Heading Eikä # Initiating Plugins

Initiate pluginName -säiliöön jQueryä käyttämällä seuraavasti:

Aloita `pluginName` säiliössäsi käyttämällä jQueryä seuraavasti:
$(function() { $('#container').pluginName(); });
`$ (function () {$ ('# container'). pluginName ();});`

Käyttämällä säiliön tunnusta voimme aloittaa pluginName jQuery-menetelmällä .pluginName()

* Kontin tunnuksemme avulla voimme käynnistää `pluginName` jQuery-menetelmällä` .pluginName () `. *

Lisäapua aloittaessasi verkossa on monia Markdown-oppaita, joiden avulla saat ajan tasalle, mukaan lukien Markdown-yleiskatsaus John Gruber (Markdownin luoja) sekä verkko Markdown-opetusohjelma .

Markdown-jäsentimet ja työkalut

Kun olet kirjoittanut artikkelin Markdownissa, tarvitset sovelluksen, joka jäsentää syntaksin HTML-muotoon. On olemassa muutamia hienoja, jotka ovat vapaa mukaan lukien:

  • PinoMuokkaa - selainpohjainen Markdown-editori, jolla on muutama synkronointivaihtoehto suosittujen palveluiden, kuten Google Drive ja Dropbox, kanssa
  • Online Kramdown Editor - toinen selainpohjainen Markdown-editori, jolla on erittäin yksinkertainen käyttöliittymä
  • Mou - paras Mac-pohjainen Markdown-kirjoittaja, jonka olen nähnyt geekier-vaihtoehtona kehittäjille; tonnia ominaisuuksia ja ilmaisia ​​(betaversiossa) [tätä kirjoitin tämän artikkelin kirjoittamiseen]
  • MarkdownPad - loistava Markdown-editori Windowsille
  • Tekstit - mukava monitasoinen (Mac ja Windows) editori; vienti useisiin muotoihin, kuten PDF, .doc ja ePub

Jotkut suuret alustat ovat jo ottaneet (tai ainakin sallineet) Markdown-käytön muokkaustoiminnossaan niille, jotka haluavat käyttää sitä. Muiden kanssa, kuten WordPress, Evernote ja Google Docs, natiivia tukea (tämän artikkelin kirjoittamisen aikaan) ei ole vielä leivottu, mutta kolmannet osapuolet ovat esittäneet mukautettuja ratkaisuja. Nämä sisältävät:

  • Suosittu uusi blogiympäristö Aave , pyrkiessään virtaviivaistamaan verkkokirjoittamista, käyttää Markdownia sisältöeditorissaan.
  • WordPressille Jetpack-laajennus tukee nyt virallisesti Markdownia, jonka voit ottaa käyttöön kohdassa Asetukset> Keskustelu jos käytät laajennusta. Tai voit käyttää laajennusta, kuten WP-Markdown joka muuntaa postitusmerkinnän sisällön HTML: ksi ja takaisin Markdowniksi, kun sinun on muokattava sitä.
  • Evernotessa jotkut Markdown-sovellukset, kuten online-editori Merkittävä tai Mac-editori Malliesimerkki sallia vienti ja julkaiseminen suoraan nuotteihin. Tai jos haluat käyttää suoraan Evernote-verkkosovellusta, voit käyttää selaimen laajennusta nimeltä Markdown täällä joka muuntaa valitun merkinnän, joka on kirjoitettu Markdown-tiedostoon, alustetuksi tekstiksi napsauttamalla työkalurivin painiketta.
  • Google-dokumentit eivät tue vielä luonnollisesti Markdownia, mutta muutama muokkausohjelma (kuten PinoMuokkaa ) viedään / synkronoidaan suoraan Driven kanssa.

Huonot puolet

Tietenkin suurella yksinkertaisuudella on rajoituksia. Kuten olen jo selittänyt, Markdownia ei ole kirjoitettu monimutkaisille tekstinkäsittelytehtäville, jotka edellyttävät edistyneitä muotoiluominaisuuksia. Jos tarvitset sitä, Markdown ei ole oikea työkalu.

Kehittäjille, jotka tarvitsevat kirjoittaa käyttöoppaan, teknisen dokumentaation tai teknisen raportin, Markdown tarjoaa lähes täydellisen tasapainon yksinkertaisuuden ja tarvitsemiesi ominaisuuksien välillä.

Ehkä suurin haittapuoli - etenkin meille insinööreille, jotka olemme muutoksenhallinnan narkkareita, on kyvyttömyys työskentele yhteistyössä Markdownissa ja muutosten seuraamiseksi (yksi merkittävä poikkeus tähän on kuitenkin PinoMuokkaa Google-dokumenttien laajennus). Ja tietysti pienellä vaivalla voidaan yksinkertaisesti tehdä yhteistyötä Markdown-dokumentin kanssa git-arkiston kautta ja saada siten kaikki muutosten seuranta ja yhteistyö, jota tyypillisesti tarvitaan.

Johtopäätös

Joten onko Markdownin oppiminen kaikille? Ei tietenkään. Kukaan työkalu ei ole koskaan.

Mutta jos olet ohjelmistoinsinööri, se voi hyvinkin olla juuri etsimäsi kirjoitustyökalu. Joten jos et ole vielä kokeillut sitä, sinun pitäisi todella ottaa se pyöriä.

Mikä aiheuttaa kohinaa iPhone-kuvauksessa ja kuinka korjata se

Ammunta

Mikä aiheuttaa kohinaa iPhone-kuvauksessa ja kuinka korjata se
Kattava opas ilmoitusten suunnittelusta

Kattava opas ilmoitusten suunnittelusta

Mobiilisuunnittelu