Markdown Ins og Outs

Markdown er et sjokkerende enkelt oppslagsspråk som lar deg skrive, ved hjelp av et lettlest, lett å skrive, vanlig tekstformat. Dette formatet kan deretter omdannes til et annet oppføringsspråk, for eksempel HTML!

Hvis du ikke er kjent med det, la meg lære deg om det i dag!

Markdown gjør en fantastisk jobb med å komme seg ut av veien.

Markdown gjør en fantastisk jobb med å komme seg ut av veien. Jeg er sikker på at alle på et tidspunkt har lagt vekt på tekst i et vanlig tekstdokument ved å omgjøre uttrykket med en stjerne, * som så *. Det er akkurat det som fungerer i Markdown! Å gi ekstra vekt (dristig et ord) er så enkelt som ** dobler opp på asterix **.

Det er ingen overraskelse at Markdowns filosofi er å produsere innhold, som kan "publiseres som-er, uten å se ut som det er merket med etiketter."

Fordelene bør være åpenbare for alle som har prøvd å skrive nettbasert innhold og måtte bekymre seg for å formatere det også. tekst her er ganske enkelt for vanskelig å skrive, når du har hjernen i sin strøm - for ikke å nevne hvordan vanvidd av HTML-koder som plager et dokument, kan ødelegge lesbarhet mens du prøver å dokumentere et dokument.

En rekke Markdown-redaktører finnes, både på nett og på skrivebordsbasis, men du kan selvfølgelig bruke noen gamle tekstredigeringsprogram. Den eneste fordelen som spesifikke Markdown-redaktører gir, er en forhåndsvisning av den genererte HTML-en, og vanligvis et visst nivå av syntaksutheving.

Hvis du vil prøve ut eksemplene nedenfor, kan du se den offisielle Dingus nettleserbaserte konverteringen.


The Markup

avsnitt

Med Markdown blir tekst automatisk omgjort til avsnitt hvor tekstblokker skilles av en tom linje. Og ikke bare av flere
merker som WYSIWYG er av dager-borte, men ekte semantisk

avsnitt. Det er nesten som svart magi.

 Det er ikke noe problem, men det er ikke noe problem, men det er ikke et øyeblikk, og det er et problem for deg. Ut som et minimum, det er en utfordring å utøve arbeidet med å utvide ut fra dette. Duis aute irure dolor i reprehenderit i voluptate velit esse cillum dolore eu fugiat nulla pariatur. Uncepteur sint occaecat cupidatat non proident, sunt i culpa de officia deserunt mollit anim id er laborum.

Blir bare:

Det er ikke noe problem, men det er ikke noe problem, men det er ikke et øyeblikk, og det er et problem for deg. Ut som et minimum, det er ikke nødvendig å utøve arbeidet med å utvide ut fra det som følger.

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

En liten oddity med Markdown er hvordan enkeltlinjepauser håndteres. Markdown-filosofien er at nettleseren skal håndtere linjeskift, og ingen andre. Så følgende tekst:

Du er her, og du er velkommen. Adipisising elit, sed gjør eiusmod tempor incididunt.

Blir ganske grusomt:

Du er her, og du er velkommen. Adipisising elit, sed gjør eiusmod tempor incididunt.

Hvis du absolutt sett inn en linjeskift, et arbeid er gitt: bare legg til to mellomrom til slutten av den forrige linjen, slik som:

Du er her, og du er velkommen. Adipisising elit, sed gjør eiusmod tempor incididunt.

En rekke Markdown-smaker kan håndtere linjeskift på måter du kan forvente, men mer om det senere.

overskrifter

Start et avsnitt med en #, og det avsnittet blir et overskrift. Antallet av # betyr overskriftenivå nummer (

,

etc.)

# Overskrift ett Dette er et avsnitt. Det er ikke noe problem, men det er ikke noe problem, men det er ikke et øyeblikk, og det er et problem for deg. Ut enim ad minim veniam. ## Overskrift to Dette er et avsnitt. Det er ikke noe problem, men det er ikke noe problem, men det er ikke et øyeblikk, og det er et problem for deg. Ut enim ad minim veniam. ### Overskrift Tre #### Overskrift Four ##### Overskrift Fem ###### Overskrift seks

Blir:

Overskrift ett

Dette er et avsnitt. Det er ikke noe problem, men det er ikke noe problem, men det er ikke et øyeblikk, og det er et problem for deg. Ut enim ad minim veniam.

Overskrift to

Dette er et avsnitt. Det er ikke noe problem, men det er ikke noe problem, men det er ikke et øyeblikk, og det er et problem for deg. Ut enim ad minim veniam.

Overskrift tre

Overskrift fire

Overskrift Fem
Overskrift seks

Det finnes også en alternativ syntaks

og

, som så:

Overskrift En =========== Dette er et avsnitt. Det er ikke noe problem, men det er ikke noe problem, men det er ikke et øyeblikk, og det er et problem for deg. Ut enim ad minim veniam. Overskrift to ----------- Dette er et avsnitt. Det er ikke noe problem, men det er ikke noe problem, men det er ikke et øyeblikk, og det er et problem for deg. Ut enim ad minim veniam.

Blockquotes

En av Markdowns store innflytelser er e-post med vanlig tekst, og dette er skinnende åpenbart, når du ser at blokkeringer er formatert akkurat som de er i e-post: prefiks med a >:

Dette er et vanlig avsnitt. > Dette er et blockquote-avsnitt. > Og blockquote fortsetter også her.

... som konverterer til:

Dette er et vanlig avsnitt.

Dette er et blockquote-avsnitt.

Og blockquote fortsetter også her.

Kode

Du kan avgrense små inline kodebiter, ved hjelp av ' tegn rundt kode.

Større blokker med kode kan defineres ved ganske enkelt å skrive inn koden på et nivå (minst en fane / fire mellomrom) - innrykksnivået vil bli fjernet. Markdown unngår automatisk alle spesialtegn inne i en blokk med kode, noe som betyr at du trygt kan kopiere i blokker uten å flytte manuelt < til < og > til > etc.

Dette er et avsnitt med en bit av 'KODE' i det.  Et annet avsnitt, men med en kodeblokk over det.


Dette er et avsnitt med en bit av 'KODE' i det.

 

Et annet avsnitt, men med en kodeblokk over det.

lister

Et annet sant eksempel på hvordan Markdown bare kommer naturlig, er hvordan du angir en liste. Bare start et avsnitt med a * (eller +, -) for å lage en uordnet liste. Bruk tall, 1., 2. etc. for bestilte lister:

Jeg vil trenge: * Snakes * Scorpions * Hamsters Så kan jeg begynne min plan for å styre verden: 1. Aquire hamstere 2. Tren slanger å ri hamstere 3. Regel verden


Jeg kommer til å trenge:

  • Snakes
  • Scorpions
  • hamstere

Da kan jeg begynne min plan for å styre verden:

  1. Aquire hamstere
  2. Tren slanger å ri hamstere
  3. Styre verden

Inline Text Elements

Vi har allerede dekket kursiviserende og fet skrift i begynnelsen av denne artikkelen (* og **), men du kan også bytte asterikene for underskrifter, hvis det er flere ting du har:

Her er noen * kursiv * tekst, og mer _italic_ tekst. Noen ** dristige ting ** her; pluss en __little__ bit mer.

Lenker er fine og enkle i Markdown (hvis du kan begå til minne om det er firkantet og rundt parentesene som kommer først ...):

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

For å vise et bilde, prefix lenskoden med en !:

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

Markdown kommer ikke i veien

Markdown er svært lindrende når det gjelder å bryte ut av oppslaget og bare bruke HTML i stedet. Hvis du trenger å ta med et bord, ta det med i HTML. Eller, hvis du helst vil skrive linkene dine i HTML-format, kan du gjøre det. Markdown er smart nok til å vite når du mener å inkludere HTML, og det fungerer rundt det.

Markdown fjerner også tegn automatisk, som for eksempel &, < and > inn i HTML-enhetens skjema. Det konverterer selvsagt intelligente felles kombinasjoner til hva du egentlig mener.

  • Tre prikker blir automatisk en ellipse: ...
  • To bindestreker blir en en-dash: --
  • Sitatkarakterer vil bli "fancy", krøllete versjoner av seg selv.

Smaker og GitHub Smaksatt Markdown

En rekke alternative Markdown-smaker finnes, som forlender standard settet med Markdown-regler. En vanlig forlengelse er lett linjebrytende, som beskrevet ovenfor. En av de mest kjente Markdown-smaker er GitHubs smaksatt markdown. Dette brukes til å markere brukerinngang overalt på deres nettsted. I tillegg til å inkludere forbedret linjebrytende støtte og en rekke tilpassinger som er spesifikke for GitHub, er min favorittfunksjon deres alternativ til kodefekting, som også lar deg spesifisere en syntaks for å markere. Bare surround en kodeblokk med " på begge sider, inkludert språket i starten, slik som:

"php "

Omdannelse

Tuts + Markdown-omformeren finner du her.

Den offisielle omformeren er skrevet i Perl, og er tilgjengelig for nedlasting på Markdown hjemmeside på Daring Fireball. Flere andre Markdown-omformere eksisterer også, for en rekke forskjellige språk - fra C ... til Ruby ... til JavaScript ... til PHP. En fullstendig liste over implementeringer finnes på Wikipedia.

En populær Ruby-implementering er RedCarpet, basert på C-biblioteket, Sundown, som gir en veldig enkel måte å tilpasse utdataene til den genererte HTML-en for å produsere din egen "smak" av Markdown.

Nylig brukte jeg dette biblioteket til å opprette en Markdown-omformer, som aksepterer GitHub Flavored Markdown (for å tillate å spesifisere et kodespråk for syntaksutheving) og utdataer den konverterte HTML-en i den spesifikke stilen som kreves av Tuts + -nettstedene. Tuts + Markdown-omformeren finner du her. Hvis du noen gang har skrevet en opplæring for dette nettstedet, må du definitivt bruke det!

Faktisk ble denne artikkelen skrevet i Markdown, ved hjelp av den populære Mou Markdown-editoren for OSX.