Markdown
Informacje ogólne
Markdown jest prostym językiem znacznikowym przeznaczonym do formatowania zwykłego tekstu, konwertowanego następnie do poprawnego składniowo kodu HTML. Markdown udostępniany jest na licencji pochodnej od BSD.
Markdown na Joggerze
Można wykorzystać Markdown do formatowania treści wpisów lub treści komentarzy na własnym joggerze.
Markdown wykorzystywany dla komentarzy nie udostępnia możliwości formatowania nagłówków, poziomych linii ani obrazków. Ponadto, automatyczna korekta znaków typograficznych została wyłączona, gdyż stosowanie jej w komentarzach powodowało różnego rodzaju pomyłki.
- Ustawienia dla nowych wpisów w panelu administracyjnym.
- Ustawienia dla komentarzy w panelu administracyjnym.
Formatowanie treści wpisów lub treści komentarzy za pomocą Textile nie jest już dostępne, ale nie ma to wpływu na dotychczasowe wpisy i komentarze.
Dostępna składnia
Elementy blokowe
Akapity i podziały linii
Akapity (znaczniki <p/>
) tworzone są z bloków tekstu, które oddzielone są za pomocą co najmniej jednej pustej linii lub linii zawierającej wyłącznie spacje lub wcięcia.
Podział linii (znacznik <br/>
) tworzony jest wyłącznie wtedy, gdy znak podziału linii poprzedzony jest co najmniej jedną spacją. W przeciwnym wypadku – i odmiennie, w porównaniu do Textile – znak podziału linii jest ignorowany.
Nagłówki
Dostępne są dwie metody formatowania nagłówków (znaczniki: <h1/>
, <h1/>
, itd.):
Nagłówek pierwszego rzędu ========================= Nagłówek drugiego rzędu -----------------------
# Nagłówek pierwszego rzędu ## Nagłówek drugiego rzędu
Nagłówki pozostałych poziomów tworzy się analogicznie.
Cytaty blokowe
Tworzenie cytatów blokowych (znaczniki <blockquote/>
) jest analogiczne do metody przyjętej do cytowania fragmentów wiadomości e-mail lub wiadomości grup dyskusyjnych:
> Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Cytaty blokowe mogą zawierać dowolne formatowanie Markdown, a zatem mogą być również zagnieżdżane.
Listy nieuporządkowane i uporządkowane
Listy nieuporządkowane (znaczniki: <ul><li/></ul>
) można tworzyć za pomocą dowolnego ze znaków znaków: gwiazdka (*
), plus (+
), pauza (-
):
* lorem * ipsum * dolor
Listy uporządkowane (znaczniki: <ol><li/></ol>
) tworzy się analogicznie, jednak w miejscu znaku powinna znaleźć się (dowolna) liczba z kropką:
1. lorem 2. ipsum 3. dolor
Listy nieuporządkowane i uporządkowane mogą zawierać dowolne formatowanie Markdown, a zatem mogą być również zagnieżdżane.
Bloki kodu
Preformatowane bloki kodu (znaczniki: <pre><code/></pre>
tworzone są na podstawie tekstu poprzedzonego co najmniej czterema spacjami lub co najmniej jednym wcięciem.
Przykładowy blok kodu
Formatowanie Markdown wewnątrz takiego blogu zostanie zignorowane.
Linie poziome
Linie poziome (znaczniki <hr/>
) można tworzyć za pomocą powtórzonego co najmniej trzy razy dowolnego ze znaków znaków: pauza (-
), gwiazdka (*
), podkreślenie (_
). Opcjonalnie, znaki te mogą być oddzielone spacjami. Przykłady:
*** * * * ********** --------------------
Elementy liniowe
Odnośniki
Dostępnych jest kilka metod formatowania odnośników (znaczniki <a/>
):
- Standardowy odnośnik:
[Tytuł](http://example.com/)
. - Odnośnik z etykietą ekranową:
[Tytuł](http://example.com/ "Etykieta")
. - Odnośnik bez zdefiniowanego tytułu:
<http://example.com/>
.
Odnośniki do adresów e-mail zostaną dodatkowo zabezpieczone przed zautomatyzowanymi metodami zbierania adresów e-mail z witryn internetowych. Należy jednak pamiętać, że zabezpieczenie nie jest całkowicie skuteczne.
Istnieje także możliwość określania docelowego adresu URI za pomocą referencji.
Emfaza i silna emfaza
Emfazę (znacznik <em/>
) i silną emfazę (znacznik <strong/>
) można tworzyć za pomocą znaków: gwiazdka (*
), podreślenie (_
):
- Emfaza:
*emfaza*
,_emfaza_
. - Silna emfaza:
**silna emfaza**
,__silna emfaza__
.
Wymienione znaki poprzedzone odwrotnym ukośnikiem są ignorowane.
Kod
Kod umieszczany wewnątrz bloku tekstu (znacznik <code/>
) tworzy się za pomocą znaków słabego akcentu (`
). Zdublowanie tych znaków po obydwu stronach formatowanego tekstu powoduje, że znajdujące się pomiędzy nimi pojedyncze znaki słabego akcentu są ignorowane.
- Standardowy znacznik kodu:
`kod`
,` kod `
. - Rozszerzony znacznik kodu:
``kod ze znakiem `, czyli słabego akcentu``, `` kod ze znakiem `, czyli słabego akcentu ``
.
Obrazki
Dostępnych jest kilka metod wstawiania obrazków (znaczniki <img/>
):
- Standardowy znacznik obrazka:
![Tekst alternatywny](http://example.com/image.png)
. - Znacznik obrazka z etykietą ekranową:
![Tekst alternatywny](http://example.com/image.png "Etykieta")
.
Formatowanie Markdown nie umożliwia zdefiniowania wymiarów obrazka.
Istnieje także możliwość określania adresu URI obrazka za pomocą referencji.