Sunday, December 29, 2019

Markdown - po co to komu?



Co to jest?

Język pozwalający na formatowanie dokumentów tekstowych (plain text).

Po co to komu?

Żeby w prosty sposób (tzn. nie bawiąc się w znaczniki HTML czy inne dziwactwa) wygenerować przyzwoicie wyglądający dokument (np. HTML, PDF, itd.).

Jak to działa?

Tworzysz dokument o rozszerzeniu .md lub .markdown, gdzie wprowadzasz wymaganą treść wraz ze znacznikami Markdown. Następnie przepuszczasz wspomniany plik przez tzw. Markdown application (parser języka Markdown), w wyniku czego otrzymujesz np. dokument HTML sformatowany dokładnie tak jak chciałeś, ale dużo niższym nakładem pracy.

Do czego mogę tego użyć?

  • do stron internetowych
  • do tworzenia dokumentów tekstowych/notatek/e-maili

Czy ktoś jeszcze na świecie używa czegoś takiego?

Składnia

Nagłówki (<h1>-<h6>) - #..######

# To jest tag HTML <h1>
## A to jest tag HTML <h2>
### Dla odmiany to jest tag HTML <h3>
###### A to ostatni z tej serii tagów - <h6>

Paragrafy (<p>) - pusta linia

To jest pierwszy paragraf, pod którym jest linia z pustą spacją

To jest drugi paragraf.    

Przejście do nowej linii (<br>) - dwie lub więcej spacji + Enter

Jakiś tekst zakończony dwoma spacjami i enterem  
Jakiś inny tekst

Wytłuszczenie (<b>) - **text** lub __text__

A tutaj będzie **tekst wyboldowany**.
Zupełnie tak samo jak __tutaj__.

Kursywa (<i>) - *text* lub _text_

A tutaj będzie *tekst pochylony*.
Zupełnie tak samo jak _tutaj_.

Kursywa + wytłuszczenie

To jest ***sposób pierwszy***.
A tutaj ___sposób drugi___.
Ale uwaga - jest też __*sposób trzeci*__.
Doszukałem się też **_czwartego_**. 

Przekreślenie (<s>) - ~~text~~

Niniejszym wykreślam ~~cię~~!.

Cytat blokowy (<blockquote>) - >

Podszedł do pracownika i powiedział:
> Pracą swą hańbił zakładu tego nie będziesz!

Listy

Listy uporządkowane

Elementy listy uporządkowanej posiadają pewną numerację (cyfry lub litery).

1. Pierwszy element
2. Drugi element
3. Trzeci element
7. Czwarty element
10. Piąty element

1. Pierwszy element
1. Drugi element
1. Trzeci element
1. Czwarty element
1. Piąty element

Wynik powyższych kodów został pokazany poniżej. Wydać na nim, że niezależnie od indeksów wprowadzonych w kodzie elementy są numerowane od 1 do ilości elementów.

Listy nieuporządkowana

Elementy listy nieuporządkowanej nie są numerowane - są luźno wymienione domyślnie po krpkach. W Markdown do numerowania można użyć znaków: +,-,*.

- pierwszy element
* drugi element 
+ trzeci element 

Listy zagnieżdzone

1. Pierwszy element
2. Drugi element
    1. Drugi element - 1
    2. Drugi element -2 
3. Trzeci element

Obrazki

![Snoopy](snoopy.gif)

Kod (<code>) - ``

Funkcja `printf` jest bardzo szeroko wykorzystywana. 

Blok kodu (<pre><code>...</code></pre>) - 4 spacje lub tab

    <html>
        <head/>
    </html>

Linia pozioma (<hr>) - *** lub --- lub ___ (3 lub więcej)

***
Jakiś tekst
-----

Linki

Go to [SoftSystem web page](www.softsystem.pl).    

Tabele

Utworzenie tabeli

|Kol1 | Kol2|Kol3|
|---|---|---|
|Text 1|Text 2|Text 3|
|Text 4|Long text 5|T 6|

Wynik:

Kol1 Kol2 Kol3
Text 1 Text 2 Text 3
Text 4 Long text 5 T 6

Wyrównywanie :--, :--:, --:

|Kolumna 1 |Kolumna2 |Kolumna 3|
|:---|:---:|---:|
|Text 1|Text 2|Text 3|
|Text 4|Long text 5|T 6|
Kolumna 1 Kolumna2 Kolumna 3
Text 1 Text 2 Text 3
Text 4 Long text 5 T 6

Podświetlanie składni językowych

```json
{
 "employee" : "Waldek",
 "salary" : "15 000"
}
```

No comments:

Search This Blog