Zastanawialiście się kiedyś, patrząc w setki kontrolek Worda, po co wam to wszystko? I tak połowy nie użyjecie, a jeśli piszecie bloga to jeszcze mniej potrzeba. Dlatego uwielbiam Markdown - jest prosty, przejrzysty i uniwersalny. Czym jest Markdown, przekonacie się poniżej.
Markdown
Markdown jest odpowiedzią na czytelność plików tekstowych vs. standard HTML. Jeśli chcielibyśmy pisać duże ilości tekstu w HTMLu to dość szybko dojdziemy do wniosku, że specjalnie wygodne to nie jest. Stąd pomysł na format tekstowy z ograniczoną ilością formatowania, który można skompilować do pliku HTML.
Podstawą jest tekst. Który jest przekształcany do akapitu, czyli <p></p>
. Jeśli chcemy jakąś sekcję wyróżnić, to posłużymy się nagłówkiem. Nagłówek zaczyna się znakiem #
i liczba tych znaków określa poziom nagłówka. #
to <h1>
, ##
to <h2>
, etc.
Czego nam jeszcze potrzeba? Pogrubienia i kursywy, które odpowiednio uzyskuje się przez **tekst**
i *tekst*
. Zamiast znaku *
można użyć _
. Jeśli pod rząd trafią się trzy gwiazdki to będziemy mieli pochylony i pogrubiony tekst.
Lecimy dalej: listy. Numerowana zaczyna się pustym wierszem, a dalej num.
, gdzie num to dowolne liczby. Jednak wygenerowana lista i tak będzie zaczynała się od 1.
. Nienumerowana lista również zaczyna się pustym wierszem a potem znakiem *
lub -
. Zwróćmy uwagę na spację po znaku listy.
Jeszcze dwie rzeczy: linki i kod. Link tworzymy przez [tekst](http://...)
, a jeśli dodamy !
na początku to otrzymamy obrazek. Kod natomiast rozróżniamy na blokowy i inline. Blokowy otrzymamy przez zrobienie wcięć (np. tab) oraz poprzedzenie pustym wierszem. Kod inline uzyskujemy przez `ticki`
.
Dodatkowo jeśli potrzebujecie użyć tagów HTML to możecie i zostaną prawidłowo przeniesione to pliku wyjściowego.
Więcej informacji na temat Markdownu znajdziecie na tej stronie.
Przykładowy plik Markdown:
# Tytuł
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam non augue vel dui euismod porttitor quis vel orci. Praesent blandit ultrices finibus. **Vivamus faucibus urna at nibh aliquet rhoncus**.
- Lorem
- ipsum
Lorem ipsum dolor sit amet, consectetur adipiscing elit. More at [lipsum.com](http://lipsum.com/)
int main() {
return 0;
}
Markdown i ja
Po pierwsze, blog który czytasz jest napisany w Markdownie. Po drugie jeśli robię sobie jakieś notatki to również używam jego składni, bo jest wygodna i pozwala na “formatowanie” w pliku czysto tekstowym. No i prawie każde repozytorium na GitHubie ma plik README.md
, który jest wyświetlany na głównej stronie projektu.