Markdown a jeho využití při vývoji

V projektech bývá dobrým zvykem mít nějaké “README” nebo obecně informační soubory, a ty se pořád ještě často ukládají jako *.txt. Výhodou je, že takový soubor se otevře a zedituje kdekoliv, na druhou stranu je škoda používat soubory bez formátování, když se formátovaný text čte o tolik líp. Proto jsem viděl “README” soubory v RTF (fuj), v HTML (daleko lepší) nebo jiných formátech (radši pomlčet), ale pokud jste v poslední době navštívili nějaký projekt na GitHubu, mohli jste vidět něco takového:

github-markdown

Díky GitHubu (ač ten sám podporuje formátů víc) i několika dalším velkým webům (např. Stack Overflow) se zdá, že se de facto standardem stává Markdown. Pokud jste ještě nikdy Markdown neviděli, jakkoliv je to nepravděpodobné, vypadá takto:

Welcome to the psake project.
=============================

psake is a build automation tool written in PowerShell.
It avoids the angle-bracket tax associated with executable XML
by leveraging the PowerShell syntax in your build scripts...

## How to get started:

**Step 1:** Download and extract the project

...

Jedná se tedy pouze o drobně naformátovaný textový soubor, který má tu výhodu, že při zachování určitých pravidel ho lze převést na hezky naformátovaný, dobře čitelný výstup.

Osobně nemám Markdown příliš v lásce, některé věci v syntaxi chybí, jiné by mohly být elegantnější a třeba odsazování bloku kódu čtyřmi mezerami mi vyloženě vadí, přesto se zdá, že tento formát “vyhrál”. Podporují ho velké weby, existují pro něj editační nástroje, převaděče v celkem libovolném jazyce apod. Ačkoliv se mi tedy třeba syntaxe Texy! líbí stokrát víc, Markdown je dnes, zdá se, nejpraktičtější volbou.

Co se nástrojů týče, Markdown je tak jednoduchý, že se dá v pohodě psát ručně, přesto bych na pár zajímavých pomocníků rád upozornil.

markdownpad

Předně doporučuji MarkdownPad – jedná se o malou Windows aplikaci, kde vlevo píšete Markdown a vpravo se rovnou zobrazuje výsledek. Fungují tam všechny obvyklé klávesové zkratky (Ctrl+I, Ctrl+B apod.), výsledek se dá snadno vyexportovat do HTML souboru a předně je možno s MarkdownPadem asociovat přípony *.md, *.markdown apod., což značně usnadní editování lokálních Markdown souborů.

vs-markdown-plugin

Podobná věc existuje i jako plugin do Visual Studia, která je navíc zajímavá tím, že zvýrazňuje strukturu už na úrovni zdrojového souboru (nadpisy tak stále obsahují formátovací znaky, ale jsou vyrenderovány větším písmem, nebo třeba odkazy jsou zvýrazněny jinou barvou apod.).

Editory existují i na webu, např. Online Markdown Editor nebo prostě začněte psát text do nějaké textarey, která Markdown podporuje, např. na Stack Overflow. Koneckonců, i tento blog v komentářích Markdown podporuje…

Zkrátka pokud děláte softwarový vývoj, může se Markdown stát sice malým, ale milým společníkem.

10 komentářů u “Markdown a jeho využití při vývoji
  1. Na Mac OS X je k dispozici Marked http://markedapp.com/, ktery umi pekne preview a k editaci muzete pouzit jaky editor chcete a styly pozit ktere chcete (napr. github). Ja to pouzivam s Sublime2 a pisu diky Jekyllu a Github pages v tom cely svuj blog.

  2. Markdown vyhrál proto, že začal nástroji pro převod, aniž by k tomu bylo potřeba PHP. A dále proto, že čeština není vhodný jazyk, pokud se má něco mezinárodně rozšířit.

    Protože dějiny se nepíší v PHP, ale stále na desktopu a v enterprise.

    V roce 2004 jste si mohli stáhnout perlovský script pro převod Markdown do XHTML.

    Už v roce 2004 jste si mohli stáhnout

  3. Nedávno mne zaujal dillinger.io díky propojení s dropboxem a githubem a taky tím, že je postaven na twitter bootstrapu.

  4. Markdown je fajn syntaxe, je blízká s Texy. Ale bylo by fajn, kdyby se vyvíjela, protože třeba to odsazování zdrojáků je naprostý fail.

    (ad M. Ponkrác: Texy nikdy s Markdownem nesoutěžilo, neměl jsem v té době takovou ambici.)

  5. D. Grudl: Já jsem nic o žádném Vašem soutěžení nepsal.

    Já jsem pouze reagoval na povzdech autora v článku, že zvítězil Markdown.

Napsat komentář

Vaše emailová adresa nebude zveřejněna. Vyžadované informace jsou označeny *

*

Mete pouvat Markdown: **Tun**, *kurzva*, `kd` atd.

Můžete používat následující HTML značky a atributy: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>