Markdown Ins och Outs

Markdown är ett chockerbart enkelt markup språk som låter dig skriva, med ett lättläst, lätt att skriva, rent textformat. Detta format kan sedan omvandlas till ett annat uppmärkningsspråk, till exempel HTML!

Om du inte känner till det, låt mig lära dig om det idag!

Markdown gör ett fantastiskt jobb att komma ur vägen.

Markdown gör ett fantastiskt jobb att komma ur vägen. Jag är säker på att alla på något sätt har lagt fram text i ett vanligt textdokument genom att omge frasen med en asterisk, * som så *. Det är precis hur det fungerar i Markdown! Att ge extra betoning (fetstil ett ord) är lika enkelt som ** dubbla upp på asterix **.

Det är ingen överraskning att Markdowns filosofi är att producera innehåll som kan "publiceras som-är, utan att se ut som om det har markerats med taggar."

Fördelarna bör vara uppenbara för alla som försökt skriva webbaserat innehåll och var tvungna att oroa sig för att formatera det också. Skriv här är helt enkelt för svårt att skriva, när du har hjärnan i flödet, för att inte tala om hur frenesen av HTML-taggar som plågar ett dokument kan förstöra läsbarheten medan du provar ett dokument.

Ett antal Markdown-redaktörer finns, både webb- och skrivbordsbaserade, men du kan självklart använda någon gammal textredigerare. Den enda fördelen som specifika Markdown-redaktörer tillhandahåller är en live-förhandsvisning av den genererade HTML-filen, och vanligtvis en viss syntaxmarkering.

Om du vill prova exemplen nedan, se den officiella Dingus-webbläsarbaserade omvandlaren.


Markup

punkterna

Med Markdown konverteras text automatiskt till stycken där textblock separeras av en tom linje. Och inte bara av flera
taggar som WYSIWYGs dagar borta, men riktiga semantiska

punkterna. Det är nästan som svart magi.

 Lorem ipsum dolor sitta amet, konsekventa adipisicing elit, sed gör det ojämnaste tillfället för tillfället att arbeta med en dolore magna aliqua. Utan minsta möjliga vänskap, det är inte nödvändigt att utöva arbetskraftsarbeten och utifrån det som följer. Duis aute irure dolor i reprehenderit i voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt i culpa de officia deserunt mollit anim id er laborum.

Blir helt enkelt:

Lorem ipsum dolor sitta amet, konsekventa adipisicing elit, sed gör det ojämnaste tillfället för tillfället att arbeta med en dolore magna aliqua. Utan minsta möjliga vänskapsmässiga utsträckning, är det viktigt att arbeta utifrån och utifrån.

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

En liten odditet med Markdown är hur en radbrytning hanteras. Markdown-filosofin är att webbläsaren ska hantera radbrytningar och ingen annan. Så följande text:

Lorem ipsum dolor sit amet, consectetur. Adipisicing elit, sed gör eiusmod tempor incididunt.

Blir ganska gammal:

Lorem ipsum dolor sit amet, consectetur. Adipisicing elit, sed gör eiusmod tempor incididunt.

Om du absolut måste Lägg in en radbrytning, ett arbetssätt tillhandahålls: Lägg bara till två mellanslag till slutet av den föregående raden, så här:

Lorem ipsum dolor sit amet, consectetur. Adipisicing elit, sed gör eiusmod tempor incididunt.

Ett antal Markdown-smaker kan hantera radbrytningar på sätt som du kan förvänta dig, men mer om det senare.

rubriker

Börja ett stycke med a #, och det stycket blir en rubrik. Antalet # anger rubriknivån (

,

etc.)

# Rubrik En Detta är en paragraf. Lorem ipsum dolor sitta amet, konsekventa adipisicing elit, sed gör det ojämnaste tillfället för tillfället att arbeta med en dolore magna aliqua. Ut enim ad minim veniam. ## Rubrik två Detta är en paragraf. Lorem ipsum dolor sitta amet, konsekventa adipisicing elit, sed gör det ojämnaste tillfället för tillfället att arbeta med en dolore magna aliqua. Ut enim ad minim veniam. ### Rubrik Tre #### Rubrik fyra ##### Rubrik Fem ###### Rubrik Sex

blir:

Rubrik 1

Detta är en paragraf. Lorem ipsum dolor sitta amet, konsekventa adipisicing elit, sed gör det ojämnaste tillfället för tillfället att arbeta med en dolore magna aliqua. Ut enim ad minim veniam.

Rubrik två

Detta är en paragraf. Lorem ipsum dolor sitta amet, konsekventa adipisicing elit, sed gör det ojämnaste tillfället för tillfället att arbeta med en dolore magna aliqua. Ut enim ad minim veniam.

Rubrik Tre

Rubrik fyra

Rubrik fem
Rubrik sex

En alternativ syntax tillhandahålls också

och

, såhär:

Rubrik 1 =========== Detta är en paragraf. Lorem ipsum dolor sitta amet, konsekventa adipisicing elit, sed gör det ojämnaste tillfället för tillfället att arbeta med en dolore magna aliqua. Ut enim ad minim veniam. Rubrik två ----------- Detta är en paragraf. Lorem ipsum dolor sitta amet, konsekventa adipisicing elit, sed gör det ojämnaste tillfället för tillfället att arbeta med en dolore magna aliqua. Ut enim ad minim veniam.

Blockquotes

En av Markdowns stora influenser är e-post med vanligt text, och detta är tydligt uppenbart, när du ser att blockquotes är formaterade exakt som i e-post: prefixed med a >:

Detta är en vanlig punkt. > Detta är en blockquote stycke. > Och blockquote fortsätter också här.

... som konverterar till:

Detta är en vanlig punkt.

Detta är en blockquote stycke.

Och blockquote fortsätter också här.

Koda

Du kan avgränsa små inline kodutdrag, med hjälp av ' karaktär runt koden.

Större block av kod kan definieras genom att helt enkelt skriva in koden på en nivå (minst en flik / fyra mellanslag) - indragningsnivån kommer att tas bort. Markdown undviker automatiskt alla specialtecken i ett block med kod, vilket innebär att du säkert kan kopiera i block av kod utan att manuellt fly. < till < och > till > etc.

Detta är en paragraf med lite "KODA' i det.  En annan punkt, men med ett kodblock ovanför det.


Detta är en paragraf med lite "KODA' i det.

 

En annan punkt, men med ett kodblock ovanför det.

listor

Ett annat riktigt exempel på hur Markdown bara kommer naturligt är hur du anger en lista. Starta bara en paragraf med a * (eller +, -) för att skapa en oorderad lista. Använd siffror, 1., 2. etc. för beställda listor:

Jag behöver: * Snakes * Scorpions * Hamsters Sedan kan jag börja min plan att regera världen: 1. Aquire hamstrar 2. Trä ormar att köra hamstrar 3. Regera världen


Jag kommer att behöva:

  • ormar
  • Scorpions
  • hamstrar

Då kan jag börja min plan att styra världen:

  1. Aquire hamstrar
  2. Trä ormar att köra hamstrar
  3. Styra världen

Inline Text Elements

Vi täckte redan kursiv och fetstil text i början av denna artikel (* och **), men du kan också byta asterick för underskrifter, om det är mer din sak:

Här är några * kursiv * text och mer _italic_ text. Några ** djärva saker ** här; plus en __little__ bit mer.

Länkar är snygga och enkla i Markdown (om du kan begå i minnet om det är fyrkant och runda parentes som kommer först ...):

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

För att visa en bild, prefix länknumret med en !:

![Google-logotypen] (images_23 / markdown-in-och-outs.png)
Google-logotypen

Markdown kommer inte i din väg

Markdown är väldigt lindrig när det gäller att bryta ut sin markering och bara använda HTML istället. Om du behöver inkludera ett bord, inkludera det i HTML. Eller om du hellre vill skriva dina länkar i HTML-format kan du göra det. Markdown är smart nog att veta när du menar att inkludera HTML, och det fungerar runt det.

Markdown avviker automatiskt tecken, t.ex. &, < and > in i HTML-enhetens formulär. Det omvandlar till och med intelligent gemensamma karaktärskombinationer till vad du verkligen menar.

  • Tre prickar blir automatiskt en ellips: ...
  • Två bindestreck kommer att bli en en-dash: --
  • Citatmärken kommer att bli "fancy", krullade versioner av sig själva.

Smaker & GitHub Smaksatt Markdown

Ett antal alternativa Markdown "smaker" existerar, vilket utökar standarduppsättningen av Markdown-regler. En vanlig förlängning är lätt linjebrytande, som beskrivits ovan. En av de mest kända Markdown-smakerna är GitHubs smaksatta Markdown. Detta används för att markera användarinmatning överallt på deras webbplats. Förutom att inkludera förbättrat raderingsstöd och ett antal anpassningar som är specifika för GitHub, är min favoritfunktion deras alternativ till kodfäste, vilket också låter dig ange en syntax för att markera. Omslut bara ett kodblock med " på båda sidor, inklusive språket i början, som så:

"php "

Omvandling

Tuts + Markdown-omvandlaren finns här.

Den officiella konverteraren är skrivet i Perl, och kan laddas ner på Markdown hemsida på Daring Fireball. Flera andra Markdown-omvandlare finns också, för en mängd olika språk - från C ... till Ruby ... till JavaScript ... till PHP. En fullständig lista över implementeringar finns på Wikipedia.

Ett populärt Ruby-genomförande är RedCarpet, baserat på C-biblioteket Sundown, vilket ger ett väldigt enkelt sätt att anpassa produktionen av den genererade HTML för att producera din egen "smak" av Markdown.

Nyligen använde jag det här biblioteket för att skapa en Markdown-omvandlare, som accepterar GitHub Flavored Markdown (för att tillåta att ange ett kodspråk för syntaxmarkering) och matar ut den konverterade HTML-filen i den specifika stilen som krävs av Tuts + -sidorna. Tuts + Markdown-omvandlaren finns här. Om du någonsin har skrivit en handledning för den här webbplatsen, använd den definitivt!

Faktum är att den här artikeln skrevs i Markdown, med den populära Mou Markdown-editoren för OSX.