Använd Markdown för Easy Web Writing

När jag lyssnat på en massa Mac-centriska podcasts nyligen, särskilt på arbetsflöden med Mac, har jag stött på ett verktyg som har funnits ett tag men är fortfarande inte extremt populärt hos alla. Verktyget heter Markdown och skapades av John Gruber (Daring Fireball fame). Det bästa sättet att förklara det är den första stycket från Markdowns beskrivning på Mr Grubers sida:

Markdown är ett text-till-HTML-konverteringsverktyg för webbskribenter. Markdown kan du skriva med ett lättläst, lätt att skriva rent textformat och konvertera det till strukturellt giltigt XHTML (eller HTML).

Ja det är det i ett nötskal. Innan jag hoppa i hur man använder det här fantastiska verktyget på Mac och Windows kanske du undrar vad meningen med ett verktyg som detta faktiskt är.

Vad är poängen?

Först fick jag inte anledningen till att du använde Markdown. Cool, du kan överföra vanliga textfiler till HTML, men vem i helvete använder HTML längre? Tja, om du är en webbförfattare använder du HTML varje dag om du vet det eller inte, och om du har använt WordPress eller något annat CMS under någon tid, har du troligtvis fått tweak some HTML.

Om du använder WordPress finns det inget mer agrevating än att WYSIWYG-redigeraren blir för hjälpsam med HTML-taggar i bakgrunden, vilket väsentligt förstör din formatering. Markdown kan hjälpa dig genom att omvandla din textfil till giltig HTML. Det här låter dig klistra in HTML-koden i HTML-redigeraren och håller sålunda din hårdvunna formatering. Så trevligt. Reklam

Det finns också något att säga för dokumentportabilitet. HTML är en agnostisk typ av dokumentmarkering och kan göras i stort sett alla galna webbläsare. Med fortsatt användning av många olika operativsystem och enheter ute i naturen (iOS, Android, Blackberry, Windows, Mac, Linux, etc.) behövs det ett standardformat för text. Markdown hjälper till med detta genom att låta dig standardisera all din notformatering utan att låsa dig in i något proprietärt format. Bara HTML och Txt-filer.

Låt oss använda det, ska vi?

Markdown är ganska darn lätt att använda och om du har någon erfarenhet som ritar aroudn med programvara och HTML kommer det att bli en snap. Markdown är skrivet i Perl, så om du inte har Perl på din Windows-maskin kan du ladda ner och installera Strawberry Perl härifrån. Om du är en Mac-användare är Perl redan installerad för dig.

Läs Nästa

10 små förändringar för att få ditt hus att känna som ett hem

Vad gör människor lyckliga? 20 hemligheter av "alltid lyckliga" människor

Hur man skärper dina överförbara färdigheter för en snabb karriärväxel

Bläddra ner för att fortsätta läsa artikeln

Därefter går du över till Daring Fireball och tar tag i Markdown.pl-skriptet, pakar ut det och lägger filen Markdown.pl i katalogen som du ska använda för att skapa och transformera dina inmatade textfiler.

Nu den roliga delen; lära sig att använda syntaxen och skapa din inmatade textfil.

Markdown-syntax

Jag ska kortfattat förklara några av de mest använda syntaxutdrag som får dig att köra med Markdown. Om du vill ha hela shebang, gå vidare till Daring Fireball för att få en detaljerad lista över alla niceties i Markdown-syntaxen.

rubriker

Huvudetiketter (h1, h2, h3, etc) är enkla att skapa i ditt textdokument. För att signera h1-taggen, “Understrykning” texten med tecknet '=': Annonsering

Detta är en h1 header ==================== 

eller för h2 använd '-' tecknet:

Detta är en h2-rubrik ------------------- 

Du behöver inte sätta samma antal '=' eller '-' tecken under rubriken; vilket nummer som helst kommer att bero på att producera rubrikens taggar.

Kulor och listor

Jag tror i kulor och listor så det är trevligt att Markdown hanterar dem bra. För att infoga en kula lägger du till en asterisk i din linje så här:

* Detta är min punkt 

Du kan också använda '+' eller '-' tecknen som kulor.

Beställda listor är också enkla:

1. Nummer ett 2. Nummer två 3. Nummer tre ... nu har du det! 

Om du vill ha flera stycken under en kula eller ett nummer anger du bara den första raden i varje stycke eller anger alla rader om du vill se det snyggare: Reklam

1. Här är den första punkten som jag försöker göra om numrerade listor. Förresten borde jag noga nämna detta också. 2. Nästa punkt 

länkar

En av mina favorit saker i Markdown är det enkla sättet att infoga länkar. Först, fäst ordet eller frasen som du skulle vilja vara “klickbara” och följ sedan med en parenteserad URL:

[klicka här] (http://www.google.com/) 

Utmatning till HTML

När du har skapat din textfil är det dags att skicka det till Markdown.pl-skriptet för att producera HTML-utmatningen. Om du inte skapade en textfil för att testa kan du ladda ner snabbtextfilen som jag skapade för att prova den.

Placera din textfil i samma katalog som Markdown.pl-skriptet (du kan skicka argumenten med rätt väg om du vill, det här är bara för att underlätta det). Därefter öppnas kommandotolken i Windows eller din terminal på din Mac eller Linux och navigera till mappen med din inmatningsfil.

För att skapa utmatningen direkt i terminalfönstret, använd följande kommando:

perl Markdown.pl input.txt

Då analyseras textfilen och matas ut den giltiga HTML-markeringen till terminalen. Om du vill att ouput ska riktas mot en helt separat HTML-filtyp, följer följande kommando: Reklam

perl Markdown.pl input.txt> output.html

Detta skapar HTML-filen output.html i vilken katalog du än befinner dig i.

Wrapping upp det

Låt mig bara säga att om du tror att Markdown är intressant och förstår nyttan av det, föreslår jag starkt att om du skriver något borde du skriva det med Markdow

n syntax. Det är plattform, öppen källkod, gratis och kompatibel med allt. För mig är det en spelväxlare och jag känner att jag är lite efter att inte utnyttja det tidigare. Än en gång finns det mycket mer till syntaxen än jag har markerat här, så kolla in Daring Fireball för mer.

Förresten skrev jag hela artikeln med Markdown och om du vill se syntaxen kan du ladda ner den här.