Preskoči na glavni sadržaj

Markdown validator i pregled

Validirajte strukturu Markdowna, pregledajte renderirani izlaz i uhvatite uobičajene probleme u pisanju prije objave.

Converty Markdown prikaz 🚀

Dobro došli u Markdown Validator & Preview na Convertyju. Ovaj primjer prikazuje širok skup mogućnosti Markdowna uz pregled uživo, sanitizirani raw HTML i strukturne povratne informacije prije objave.

Koristite kurziv, podebljani tekst, precrtani tekst, inline kod i prisilni prijelom retka.
Ovaj drugi red potvrđuje da se prijelom retka zadržava i u pregledu.

Pritisnite Cmd + Enter, napišite H2O, usporedite 210 s 2102^{10} i zadržite sporedne bilješke u fusnotama.1

Made by VLG Software Version

Stvarne Converty poveznice

Autolink: https://github.com/remarkjs/remark-math
Email: hello@example.com
Referentna poveznica: Generator favicona

Liste i zadaci

  1. Izradite nacrt
  2. Pregledajte strukturu
    • Provjerite da ugniježđene liste ostanu čitljive
    • Provjerite inline formatiranje i poveznice
  3. Objavite s povjerenjem
  • Naslovi su organizirani
  • Tablice su poravnane
  • Blokovi koda su označeni
  • Formule se renderiraju pomoću KaTeX-a
  • Završna lektura još čeka

Markdown ostaje čitljiv u običnom tekstu i dotjeran u pregledu.

Koristite validator kada želite brzu provjeru prije objave.

Tablica

AlatNajbolji zaStatus
CSV Validatorotkrivanje strukturnih problemaSpremno
Data ConverterJSON, YAML, TOML i CSVSpremno
Favicon Generatorpakete ikona za preglednikSpremno
WebP Converteroptimizaciju slikaSpremno

Mediji

Converty slika za pregled

Primjeri koda

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 radi: E=mc2E = mc^2, x2+y2\sqrt{x^2 + y^2} i 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}

Dodaci sa sigurnim HTML-om

Sigurni raw HTML ostaje vidljiv nakon sanitizacije, dok se nesigurni handleri i protokoli uklanjaju.

Zašto miješati Markdown i sanitizirani HTML?

Možete dodati disclosure elemente, tipkovničke prečace, indekse i eksponente bez uvođenja nesigurnih skripti ili event handlera.


Trebate brz put do ostatka Convertyja? Posjetite početnu stranicu, pregledajte česta pitanja ili čitajte blog za duže sadržaje.

Ovaj primjer uključuje referencu fusnote2 i drži definicije referentnih poveznica odvojene od fusnota, tako da se reference ispravno razrješavaju.

Footnotes

  1. KaTeX prikazuje i inline i block formule unutar pregleda.

  2. Validator i dalje može povezati upozorenja s izvornim redovima i blokovima pregleda.

Nisu otkriveni problemi
Za trenutni Markdown dokument nisu pronađeni problemi validacije.

O validaciji i pregledu Markdowna

Markdown validatori su najkorisniji kada kombinuju stvaran pregled s ciljanim povratnim informacijama za pisanje. Tako možete provjeriti i izgled dokumenta i uobičajene strukturne ili pristupačne probleme.

Pregled prije objavljivanja

Renderirani pregled pomaže da uočite iznenađenja u formatiranju prije nego što Markdown završi u dokumentaciji, CMS poljima, release notesima ili tekstovima proizvoda.

Pregled naslova, tabela, citata i blokova koda u konačnom obliku ubrzava provjeru.

Sigurno renderiranje sirovog HTML-a

Markdown često dopušta inline HTML, ali javni pregledi ipak trebaju ukloniti nesigurne skripte, handlere i loše protokole.

Sanitizacija vam omogućuje da testirate realan izlaz bez povjerenja u izvorni markup.

Upozorenja za pisanje koja zaista znače

Fokusirana upozorenja hvataju probleme poput skokova u nivoima naslova, duplih H1 naslova, nedostajućeg alt teksta, praznih linkova i neoznačenih code fence blokova.

To autorima daje praktičan povratne informacije bez pretvaranja Markdowna u težak lint radni tijek.

Česta pitanja

Odgovori o GitHub-flavored podršci za Markdown, sigurnom renderiranju HTML-a, upozorenjima za pisanje i tome što pregled radi sa sumnjivim markupom.

Ostali alati

Pregledajte svaku posebnu stranicu alata sa početne stranice ili iz centralnog birača u zaglavlju.