Markdown de Ins en Outs

Markdown is een verrassend eenvoudige opmaaktaal waarmee je kunt schrijven met een gemakkelijk te lezen, gemakkelijk te schrijven, platte tekstindeling. Deze indeling kan vervolgens in seconden worden geconverteerd naar een andere opmaaktaal, zoals HTML!

Als je er niet bekend mee bent, laat me je er vandaag over leren!

Markdown doet fantastisch werk om uit de weg te gaan.

Markdown doet fantastisch werk om uit de weg te gaan. Ik ben er zeker van dat iedereen op een gegeven moment de nadruk heeft gelegd op tekst in een platte tekst door de zin te omsluiten met een asterisk, * like so *. Dat is precies hoe het werkt in Markdown! Het geven van extra nadruk (een woord vet maken) is zo simpel als ** verdubbelen op de asterix **.

Het is geen verrassing dat de filosofie van Markdown is om content te produceren, die kan worden "gepubliceerd zoals het is, zonder eruit te zien alsof het is gemarkeerd met tags."

De voordelen moeten duidelijk zijn voor iedereen die geprobeerd heeft webinhoud te schrijven en zich zorgen moet maken over het formatteren ervan. tekst hier is gewoon te moeilijk om te typen, als je hersenen eenmaal in de flow zijn - om nog maar te zwijgen over hoe de waanzin van HTML-tags die een document teisteren de leesbaarheid kan aantasten terwijl je een document test.

Er bestaan ​​een aantal Markdown-editors, zowel op het web als op de desktop, maar u kunt natuurlijk elke oude teksteditor gebruiken. Het enige voordeel dat specifieke Markdown-editors bieden, is een live-preview van de gegenereerde HTML en meestal een niveau van syntax highlighting.

Als u de onderstaande voorbeelden wilt uitproberen, raadpleegt u de officiële browserconverter Dingus.


De markup

De leden

Met Markdown wordt tekst automatisch geconverteerd naar alinea's waarin tekstblokken worden gescheiden door een lege regel. En niet alleen door meerdere
tags zoals WYSIWYG's van vervlogen dagen, maar echte semantische

paragrafen. Het lijkt bijna op zwarte magie.

 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minimus veniam, quis nostrud exercise ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Wordt gewoon:

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim ving, quis nostrud exercise ullamco laboris nisi ut aliquip ex ea commodo.

Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Een kleine rariteit met Markdown is hoe enkele regeleinden worden afgehandeld. De filosofie van Markdown is dat de browser regelafbreking moet afhandelen, en niemand anders. Dus de volgende tekst:

Lorem ipsum dolor sit amet, consectetur. Adipisicing elit, sed do eiusmod tempor incididunt.

Wordt, nogal schokkend:

Lorem ipsum dolor sit amet, consectetur. Adipisicing elit, sed do eiusmod tempor incididunt.

Als je absoluut moet voeg een regeleinde in, er wordt een omweg geboden: voeg gewoon twee spaties toe aan het einde van de vorige regel, zoals:

Lorem ipsum dolor sit amet, consectetur. Adipisicing elit, sed do eiusmod tempor incididunt.

Een aantal Markdown "smaken" kan regeleinden afhandelen op manieren die je zou verwachten, maar daarover later meer.

rubrieken

Begin een alinea met een #, en die paragraaf wordt een kop. Het aantal # betekent het koersniveaunummer (

,

enz.)

# Heading One Dit is een alinea. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim Veniam. ## Heading Two Dit is een alinea. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim Veniam. ### Kop drie #### Kop vier ##### Kop vijf ###### Kop zes

Wordt:

Op weg naar een

Dit is een paragraaf. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim Veniam.

Kop twee

Dit is een paragraaf. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim Veniam.

Kop drie

Kop vier

Kop vijf
Kop zes

Een alternatieve syntaxis is ook voorzien

en

, zoals zo:

Kop één =========== Dit is een paragraaf. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim Veniam. Kop twee ----------- Dit is een paragraaf. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim Veniam.

Blok citaten

Een van de belangrijkste invloeden van Markdown is e-mail met platte tekst, en dit is overduidelijk, als je ziet dat blockquotes zijn opgemaakt precies zoals ze zijn in e-mail: voorafgegaan door een >:

Dit is een normale paragraaf. > Dit is een alinea met een blokquote. > En de blockquote gaat hier ook door.

... Welke converteert naar:

Dit is een normale paragraaf.

Dit is een alinea met een blockquote.

En de blockquote gaat hier ook door.

Code

U kunt kleine inline-codefragmenten verwijderen met behulp van de ' karakter rond code.

Grotere codeblokken kunnen worden gedefinieerd door de code simpelweg een niveau hoger in te tikken (ten minste één tab / vier spaties) - het inspringniveau wordt verwijderd. Markdown onttrekt automatisch alle speciale tekens in een codeblok, wat betekent dat je veilig in blokken code kunt kopiëren zonder handmatig te ontsnappen < naar < en > naar > enz.

Dit is een alinea met een beetje 'CODE' in het.  Nog een alinea, maar met een codeblok erboven.


Dit is een alinea met een beetje 'CODE' in het.

 

Nog een alinea, maar met een codeblok erboven.

lijsten

Een ander echt voorbeeld van hoe Markdown net van nature komt, is hoe u een lijst opgeeft. Start eenvoudig een alinea met een * (of +, -) om een ​​ongeordende lijst te maken. Gebruik nummers, 1., 2. etc. voor bestelde lijsten:

Ik heb nodig: * Snakes * Scorpions * Hamsters Dan kan ik mijn plan beginnen om de wereld te regeren: 1. Aquire hamsters 2. Train slangen om hamsters te rijden 3. Rule the world


Ik zal nodig hebben:

  • Snakes
  • Scorpions
  • hamsters

Dan kan ik mijn plan beginnen om de wereld te regeren:

  1. Aquire hamsters
  2. Train slangen om hamsters te rijden
  3. Heers over de wereld

Inline tekstelementen

We hebben al cursiverende en vetgedrukte tekst aan het begin van dit artikel behandeld (* en **), maar u kunt ook de astericks omwisselen voor underscores, als dat meer uw ding is:

Hier is wat * cursieve * tekst en meer _itieke_ tekst. Sommige ** vetgedrukte dingen ** hier; plus een __little__ beetje meer.

Links zijn leuk en eenvoudig in Markdown (als je je kunt vastleggen of het de vierkante en ronde haakjes zijn die het eerst komen ...):

[Google] (http://google.com)
Google

Om een ​​afbeelding weer te geven, voert u de linkcode in met een !:

![Het Google-logo] (images_23 / markdown-the-ins-and-outs.png)
Het Google-logo

Markdown komt niet op jouw manier

Markdown is erg inschikkelijk als het gaat om het doorbreken van de markup en gewoon HTML gebruiken. Als u een tabel wilt opnemen, neemt u deze op in HTML. Of, als u liever uw links in HTML-indeling schrijft, kunt u dat doen. Markdown is slim genoeg om te weten wanneer u HTML wilt opnemen, en het werkt er omheen.

Markdown biedt ook automatisch escapetekens, zoals &, < and > in het HTML-entiteitsformulier. Het converteert zelfs gewone karaktercombinaties intelligent naar wat je echt bedoelt.

  • Drie punten worden automatisch een ellips: ...
  • Twee koppeltekens worden een en-streepje: --
  • Citaatmerken worden de 'mooie', gekrulde versies van zichzelf.

Smaken & GitHub gearomatiseerde markdown

Er bestaat een aantal alternatieve Markdown "smaken", die de standaardset markdown-regels uitbreiden. Een veelvoorkomende extensie is eenvoudig lijnvast, zoals hierboven beschreven. Een van de meest bekende Markdown-smaken is Guttub's gearomatiseerde markdown. Dit wordt gebruikt voor het markeren van gebruikersinvoer overal op hun site. Naast het feit dat ik verbeterde baanbrekende ondersteuning en een aantal customisaties specifiek voor GitHub heb toegevoegd, is mijn favoriete functie hun alternatief voor code schermen, waarmee je ook een syntaxis voor markeren kunt opgeven. Omzeil eenvoudig een codeblok met " aan beide kanten, inclusief de taal aan het begin, zoals zo:

"php "

conversie

De Tuts + Markdown-converter is hier te vinden.

De officiële converter is geschreven in Perl en kan worden gedownload op de startpagina van Markdown bij Daring Fireball. Verschillende andere Markdown-converters bestaan ​​ook, voor een veelvoud aan verschillende talen - van C ... tot Ruby ... tot JavaScript ... tot PHP. Een volledige lijst van implementaties is te vinden op Wikipedia.

Een populaire Ruby-implementatie is RedCarpet, gebaseerd op de C-bibliotheek, Sundown, die een zeer eenvoudige manier biedt om de uitvoer van de gegenereerde HTML aan te passen om je eigen "smaak" van Markdown te produceren.

Onlangs heb ik deze bibliotheek gebruikt om een ​​Markdown-converter te maken, die GitHub-gearomatiseerde markdown accepteert (om een ​​codetaal voor syntaxisaccentuering toe te staan), en de geconverteerde HTML uitvoert in de specifieke stijl die vereist is door de Tuts + -sites. De Tuts + Markdown-converter is hier te vinden. Als je ooit een tutorial voor deze site hebt geschreven, gebruik deze dan zeker!

In feite is dit artikel geschreven in Markdown, met behulp van de populaire Mou Markdown-editor voor OSX.