Alkuperäinen Markdown

Muutettu Markdown

Vertailuraportti

Markdown-vertailun esimerkkejä

Vertaile kahta Markdown-versiota. Esimerkki:

Esimerkki: Suunnitelma lisätyllä kohdalla

Alkuperäinen Markdown

Muutettu Markdown (lisätty kohta C):

Muutettu Markdown

Vertailuraportti

Vertailuraportti

Napsauta Esimerkki-painiketta ladataksesi lisää esimerkkejä editoreihin.

Mikä on Markdown-vertailutyökalu?

Markdown-vertailutyökalu vertaa kahta Markdown-versiota ja näyttää rivi riviltä erot. Liitä alkuperäinen vasempaan paneeliin ja muutettu versio keskelle; oikea paneeli näyttää vertailuraportin. CommonMark-spesifikaatio määrittelee Markdown-syntaksin.

Työkalu toimii kokonaan selaimessasi. Mitään ei lähetetä palvelimelle. Käytä Esimerkki-painiketta ladataksesi esimerkkidataa. Muotoiluun tai validointiin käytä Markdown-muotoilutyökalua tai Markdown-validaattoria. Lintaukseen käytä Markdown Linteriä.

Kuinka käyttää tätä työkalua

1

Liitä alkuperäinen ja muutettu versio

Liitä alkuperäinen Markdown vasempaan paneeliin ja muutettu versio keskelle. Käytä Esimerkki-painiketta ladataksesi esimerkkisisältöä. Käytä Tyhjennä-painiketta nollataksesi molemmat.

2

Tarkista vertailuraportti

Oikea paneeli näyttää lisätyt, poistetut ja muutetut rivit. Käytä tätä muutosten tarkasteluun, muutosseurantaan tai korjausmuistiinpanojen valmisteluun.

3

Kopioi tai lataa raportti

Käytä Kopioi tai Lataa tallentaaksesi vertailuraportin. Sisällysluettelon luomiseen kummasta versiosta tahansa käytä Markdown TOC -generaattoria.

Milloin Markdown-vertailutyökalu auttaa

Kun vertailet luonnoksia, tarkastelet PR:iä GitHubissa tai GitLabissa, tai seuraat dokumenttimuutoksia, vertailu näyttää tarkalleen mitä muuttui. GFM-spesifikaatio määrittelee Markdownin. Sopii dokumentaatiotyönkulkuihin, README-päivityksiin ja sisällön tarkastukseen. Tyyliongelmaisten tarkistukseen käytä Markdown Linteriä. Muuntamiseen käytä Markdown HTML:ksi -työkalua.

Usein kysyttyä

Lähettääkö tämä työkalu Markdown-sisältöni palvelimelle?

Ei. Vertailu tapahtuu kokonaan selaimessasi. Markdown-sisältöäsi ei ladata minnekään — turvallinen yksityisille asiakirjoille, julkaisemattomalle sisällölle tai sisäisille wikeille.

Voinko vertailla renderöityä Markdownia vai vain raakaa tekstiä?

Tämä työkalu vertaa raakaa Markdown-lähdetekstiä, ei renderöityä HTML-tulostetta. Tämä on hyödyllisempää muokkauksessa — näet täsmälleen, mitkä merkit ja muotoilusymbolit muuttuivat.

Miten tämä eroaa git diffistä?

git diff vaatii git-repositorion ja komentorivin käytön. Tämä työkalu toimii välittömästi selaimessa kahdella Markdown-pätkällä — ilman versiohistoriaa tai terminaalia.

Mitä Markdown-variantteja se tukee?

Se vertaa pelkkää tekstiä — joten mikä tahansa Markdown-variantti toimii: CommonMark, GitHub Flavored Markdown tai mikä tahansa muu variantti. Diff on raakatekstillä, ei jäsennetyllä tuloksella.

Voinko viedä korjaustiedostona?

Raportti näyttää vertailun. Unified diff- tai patch-muotoa varten tarvitset erillisen diff-työkalun tai git diff -komennon.

Liittyvät työkalut

Lue lisää: CommonMark, CommonMark-spesifikaatio, Markdown Guide, GFM, git diff, GitHub, W3C HTML.