Logo knižnice Parsedown alebo ilustrácia Markdown

Chcete písať obsah pre web jednoducho, rýchlo a bez nutnosti klikať na desiatky ikon vo vizuálnom editore?

Presne na to slúži Markdown – jednoduchý značkovací jazyk, ktorý vám umožní formátovať text písaním bežných znakov. A motorom, ktorý tento jednoduchý text premieňa na krásne naformátovaný HTML kód na tomto blogu, je knižnica Parsedown.php.

V tomto článku sa ponoríme do všetkého, čo Parsedown dokáže. Od základov až po pokročilé techniky a bezpečnostné nastavenia.

Čo je Parsedown?

Parsedown je PHP knižnica, ktorá neuveriteľne rýchlo a presne konvertuje Markdown text na HTML. Jej hlavné výhody sú:

  • 🚀 Rýchlosť: Patrí medzi najrýchlejšie Markdown parsery pre PHP.
  • ✅ Kompatibilita: Podporuje štandard CommonMark a pridáva niekoľko užitočných vylepšení.
  • 🛡️ Bezpečnosť: Obsahuje tzv. "Safe Mode", ktorý chráni váš web pred škodlivým kódom.
  • ⚙️ Rozšíriteľnosť: Dá sa ľahko prispôsobiť a rozšíriť o vlastné funkcie.

Základná syntax Markdownu (Čo všetko môžete použiť)

Toto sú stavebné kamene každého článku.

Nadpisy

Vytvárajú štruktúru článku. Použite mriežku (#) pre šesť úrovní nadpisov.

Ukážka syntaxe:

# Nadpis úrovne 1
## Nadpis úrovne 2
### Nadpis úrovne 3

Odseky a zalomenie riadkov

Jednoducho píšte text. Nový odsek vytvoríte vynechaním jedného prázdneho riadku. Ak chcete zalomiť riadok v rámci jedného odseku (vytvoriť <br>), ukončite riadok dvoma medzerami a stlačte Enter.

Zvýraznenie textu

Zdôraznite dôležité slová.

  • Pre kurzívu použite: *Tento text bude kurzívou*
  • Pre tučný text použite: **Tento text bude tučný**
  • Pre tučnú kurzívu použite: ***Tento text bude tučný a kurzívou***
  • Pre prečiarknutý text použite: ~~Tento text bude prečiarknutý~~

Zoznamy

Prehľadne štrukturujte informácie.

*Nečíslovaný zoznam (pomocou `,-alebo+`):**

* Prvá položka
* Druhá položka
  - Vnorené položky
* Tretia položka

Číslovaný zoznam:

1. Krok jedna
2. Krok dva
3. Krok tri

Citácie

Zvýraznite citát alebo dôležitú poznámku pomocou >. Dajú sa aj vnoriť (>>).

Ukážka syntaxe:

> Toto je bloková citácia. Je ideálna na oddelenie textu, ktorý si zaslúži špeciálnu pozornosť.
>
> > Dajú sa dokonca aj vnoriť.

Kód

Pre technické články je kľúčové správne zobrazenie kódu.

Inline kód: Obklopte kód jedným spätným apostrofom: `echo "Hello, World!";`.

Blok kódu: Obklopte blok kódu tromi spätnými apostrofmi (```). Pre farebné zvýraznenie syntaxe pridajte za začiatočné apostrofy názov jazyka.

Ukážka syntaxe:

"```php
<?php
class HelloWorld {
    public function sayHello() {
        return "Hello, World!";
    }
}
```"
<?php
class HelloWorld {
    public function sayHello() {
        return "Hello, World!";
    }
}

Odkazy a obrázky

Prepojte svoj obsah.

  • Odkaz: [Text odkazu](https://www.google.com) - Text odkazu
  • Obrázok: ![Alt text obrázka](cesta/k/obrazku.jpg) - Alt text obrázka

Horizontálna čiara

Na vizuálne oddelenie sekcií použite tri pomlčky, hviezdičky alebo podčiarkovníky na samostatnom riadku.

Ukážka syntaxe:

---

Pokročilé funkcie Parsedown

Tabuľky

Parsedown podporuje jednoduchú syntax pre tabuľky pomocou zvislých čiar a pomlčiek. Dvojbodky určujú zarovnanie stĺpca.

Ukážka syntaxe:

| Hlavička 1 | Hlavička 2 | Hlavička 3 |
| :--- | :---: | ---: |
| Zarovnané vľavo | Centrované | Zarovnané vpravo |
| Obsah | `kód` | **text** |
Hlavička 1 Hlavička 2 Hlavička 3
Zarovnané vľavo Centrované Zarovnané vpravo
Obsah kód text

Automatické odkazy

Parsedown automaticky premení textové URL na klikateľné odkazy: https://www.github.com.

Povolené HTML

V predvolenom nastavení Parsedown umožňuje vkladať priamo HTML kód. Napríklad môžete vytvoriť tlačidlo: <button>Klikni na mňa</button> - .

Pozor: Povolenie HTML môže predstavovať bezpečnostné riziko. Našťastie, Parsedown má riešenie.

Bezpečnosť: setSafeMode()

Ak by obsah mohol vkladať ktokoľvek iný, je nevyhnutné zapnúť bezpečný režim. Safe Mode zabezpečí, že akýkoľvek HTML kód v Markdown texte sa nezobrazí ako HTML, ale ako neškodný text.

Ukážka v PHP:

$Parsedown = new Parsedown();
$Parsedown->setSafeMode(true);

// Tento vstup bude bezpečne escapovaný, nie spustený
$markdown = '<script>alert("Hacknuté!");</script>';
echo $Parsedown->text($markdown);

Prispôsobenie správania

Automatické zalomenie riadkov: setBreaksEnabled()

Štandardne Markdown ignoruje jedno zalomenie riadku. Ak chcete, aby sa každý nový riadok v texte premenil na <br>, použite túto funkciu.

Ukážka v PHP:

$Parsedown = new Parsedown();
$Parsedown->setBreaksEnabled(true); // Zapne automatické <br>

$markdown = "Prvý riadok.
Druhý riadok.";
echo $Parsedown->text($markdown);

Záver

Parsedown je malá knižnica s obrovskými možnosťami. Umožňuje vám sústrediť sa na to najdôležitejšie – na kvalitný obsah – zatiaľ čo sa v pozadí stará o bezchybnú a rýchlu transformáciu do HTML.

Teraz, keď poznáte všetky jej triky, môžete naplno využiť jej potenciál pri tvorbe ďalších článkov pre váš blog!