kodowanie: Markdown w MacDown

Często podczas pracy trzeba stworzyć dokumentację do aktualnego projektu. Do napisania jej można co prawda użyć dowolnego edytora tekstowego, ale najszybciej można ją chyba napisać w języku Markdown, który został stworzony w celu sformatowania tekstu w sposób najbardziej uproszczony, a co za tym idzie bardzo szybko.

Składnia w Markdown jest bardzo prosta i często mówi się, że jeśli ktoś umie pisać emotikony to też potrafić będzie  pisać w Markdown :). Ponieważ formatowanie bazuje na tagach HTML pisanie tesktów jest bardzo szybkie i konwersja takich dokumentów na inne formaty jest też bezproblemowa. Oczywiście jest to język wieloplatformowy więc można jednocześnie pracować nad tekstem na PC, Maku czy Linuxie.

Mały przykład składni w Markdown. Jeśli chcemy stworzyć listę nienumerowaną (z punktorami) możemy w Markdown napisać to tak:

Powyższy kod będzie miał swój odpowiednik w HTMLu czyli:

Wynikiem obu kodów będzie następujący blok:

  • dom jednorodzinny
  • blok
  • fabryka

W którym języku łatwiej i szybciej napisać jakiś sformatowany tekst? Odpowiedź jest chyba prosta. Na końcu artykułu parę linków wprowadzających do Markdown.

Narzędzi do pisania w Markdown jest sporo i tych darmowych i tych komercyjnych. Jednak jednym z nich jest otwarty edytor MacDown oczywiście dla użytkowników Maków. Co ciekawego jest w tym edytorze? Oprócz renderowania HTMLu można też używać tagów TeX’a, GFM czy Jekyll’a. W blokach tekstów źródłowych podświetla składnię całkiem sporej listy języków programowania (aktualna lista znajduje się tutaj). Dodatkowo wspiera także automatyczne uzupełnianie tagów. Jak na darmowe narzędzie jest tego sporo i polecam samego Macdown’a jak i pisanie czegokolwiek w Markdown’ie 🙂

Pomocne linki:

http://www.markdowntutorial.com

http://five.squarespace.com/display/ShowHelp?section=Markdown

http://daringfireball.net/projects/markdown/syntax