Přeskočit na hlavní obsah

Validátor Markdownu a náhled

Validujte strukturu Markdownu, zobrazte si vykreslený výstup a zachyťte běžné autorské chyby ještě před publikováním.

Ukázka Markdownu v Converty 🚀

Vítejte v Markdown Validator & Preview od Converty. Tato ukázka předvádí širokou sadu možností Markdownu včetně živého náhledu, sanitizovaného raw HTML a strukturální zpětné vazby ještě před publikováním.

Použijte kurzívu, tučný text, přeškrtnutí, inline kód a vynucené zalomení řádku.
Tento druhý řádek potvrzuje, že se v náhledu vynucené zalomení zachová.

Stiskněte Cmd + Enter, napište H2O, porovnejte 210 s 2102^{10} a nechte vedlejší poznámky ve footnotes.1

Made by VLG Software Version

Skutečné odkazy v Converty

Autolink: https://github.com/remarkjs/remark-math
Email: hello@example.com
Referenční odkaz: Generátor favicon

Seznamy a úkoly

  1. Připravte koncept
  2. Zkontrolujte strukturu
    • Ověřte, že vnořené seznamy zůstávají čitelné
    • Zkontrolujte inline formátování a odkazy
  3. Publikujte s jistotou
  • Nadpisy jsou uspořádané
  • Tabulky jsou zarovnané
  • Bloky kódu jsou označené
  • Vzorce se vykreslují pomocí KaTeX
  • Závěrečná korektura ještě čeká

Markdown zůstává čitelný v prostém textu a v náhledu působí uhlazeně.

Použijte validátor, když chcete rychlou kontrolu před publikováním.

Tabulka

NástrojNejvhodnější proStav
CSV Validatorodhalování strukturálních problémůPřipraveno
Data ConverterJSON, YAML, TOML a CSVPřipraveno
Favicon Generatorbalíčky ikon pro prohlížečPřipraveno
WebP Converteroptimalizaci obrázkůPřipraveno

Média

Náhledový obrázek Converty

Ukázky kódu

type ReleaseNote = {
  slug: string
  title: string
}

export function buildSummary(note: ReleaseNote) {
  return `${note.title} (${note.slug})`
}
pnpm lint
pnpm test
pnpm build
{
  "tool": "markdown-validator",
  "status": "ready",
  "supportsMath": true
}

Matematika

Inline matematika funguje: E=mc2E = mc^2, x2+y2\sqrt{x^2 + y^2} a n=14n=10\sum_{n=1}^{4} n = 10.

f(x)=01x2dx=13f(x) = \int_{0}^{1} x^2 \, dx = \frac{1}{3} [1234][xy]=[x+2y3x+4y]\begin{bmatrix} 1 & 2 \\ 3 & 4 \end{bmatrix} \begin{bmatrix} x \\ y \end{bmatrix} = \begin{bmatrix} x + 2y \\ 3x + 4y \end{bmatrix}

Doplňky s bezpečným HTML

Bezpečné raw HTML zůstává po sanitizaci viditelné, zatímco nebezpečné handlery a protokoly se odstraní.

Proč kombinovat Markdown se sanitizovaným HTML?

Můžete přidat disclosure prvky, klávesové zkratky, dolní indexy a horní indexy bez zavádění nebezpečných skriptů nebo event handlerů.


Potřebujete rychlou cestu ke zbytku Converty? Navštivte domovskou stránku, projděte si časté dotazy nebo si přečtěte blog pro delší obsah.

Tato ukázka obsahuje odkaz na poznámku pod čarou2 a drží definice referenčních odkazů odděleně od footnotes, aby se odkazy správně vyhodnocovaly.

Footnotes

  1. KaTeX vykresluje v náhledu jak inline, tak blokové rovnice.

  2. Validátor stále dokáže propojit upozornění se zdrojovými řádky a bloky v náhledu.

Nebyly zjištěny žádné problémy
V aktuálním dokumentu Markdown nebyly nalezeny žádné validační problémy.

O validaci a náhledu Markdownu

Validátory Markdownu jsou nejužitečnější tehdy, když kombinují skutečný náhled s cílenou zpětnou vazbou k psaní. Pomáhá vám to zkontrolovat jak vzhled dokumentu, tak běžné strukturální nebo přístupnostní problémy.

Náhled před publikováním

Vykreslený náhled vám pomůže zachytit překvapení ve formátování ještě předtím, než se Markdown dostane do dokumentace, polí CMS, release notes nebo produktového textu.

Když vidíte nadpisy, tabulky, citace a bloky kódu v konečné podobě, kontrola je rychlejší.

Bezpečné vykreslení raw HTML

Markdown často dovoluje vložené HTML, ale veřejné náhledy by měly stále odstraňovat nebezpečné skripty, handlery a chybné protokoly.

Sanitizace vám umožní testovat realistický výstup, aniž by bylo nutné důvěřovat zdrojovému značkování.

Upozornění na psaní, která dávají smysl

Cílená upozornění zachytí problémy, jako jsou skoky mezi úrovněmi nadpisů, více nadpisů H1, chybějící alt text, prázdné odkazy a neoznačené bloky kódu.

Autoři tak dostanou praktickou zpětnou vazbu, aniž by se z Markdownu stal těžkopádný lintingový workflow.

Často kladené otázky

Odpovědi o podpoře Markdownu ve stylu GitHubu, bezpečném vykreslování HTML, upozorněních pro autory a o tom, co náhled dělá s podezřelým značkováním.

Další nástroje

Procházejte všechny samostatné stránky nástrojů z úvodního rozcestníku nebo z vycentrovaného selektoru v záhlaví.