Porovnání Markdown dokumentů online
Porovnání Markdown dokumentů zdarma
README.md se rozjelo? Sem s oběma verzemi. Ukážu co se změnilo - a taky jak to bude vypadat.
Tip: Použijte Ctrl+Enter pro rychlé porovnání
Kdo to potřebuje?
Vývojáři
Review změn v README.md před mergem. Porovnání CHANGELOG.md mezi verzemi. Kontrola že někdo neodstranil důležitou sekci z dokumentace.
Tech writeři
Porovnání verzí API dokumentace. Kontrola změn ve wiki před publikací. Sledování co editor změnil v textu.
Blogeři a copywriteři
Porovnání draftu s finální verzí článku. Co změnil korektor? Verzování textů v Markdownu (Obsidian, iA Writer, Bear).
V čem je to lepší než textový diff?
1Renderovaný náhled
Nevidíte jen # Nadpis - vidíte jak ten nadpis vypadá. Formátování, odrážky, tabulky - vše vykreslené.
2GFM podpora
GitHub Flavored Markdown včetně tabulek, checkboxů a emoji. README z GitHubu se zobrazí přesně tak, jak jste zvyklí.
3Kódové bloky
Když máte v dokumentaci ukázky kódu, diff je správně oddělí a nezmixuje s okolním textem.
4Lokální zpracování
Interní dokumentace, drafty článků - nic neopouští váš počítač. Celé porovnání běží v prohlížeči.
Jak na to? Nic složitého
Vezměte dva Markdown soubory
README z Gitu, článek z blogu, dokumentaci - cokoliv v Markdownu. Stačí .md soubor nebo prostě text s Markdown syntaxí.
Vložte do editorů
Vlevo starší verze, vpravo novější. Přetáhněte soubory nebo Ctrl+V - jak chcete.
Podívejte se na změny
Uvidíte rozdíly v syntaxi - co se změnilo v nadpisech, odkazech, seznamech. Plus náhled jak to bude vypadat.
Ukázka: Co všechno poznám
Nejde jen o holý text - rozumím Markdown syntaxi a změny v ní vyznačím speciálně:
Nadpisy a formátování
# Hlavní nadpis ## Podnadpis **tučný text** a *kurzíva* ~~přeškrtnutý text~~
Seznamy a odkazy
- položka seznamu - další položka - vnořená položka [odkaz](https://example.com) 
Když někdo změní ## Instalace na ## Jak nainstalovat, hned to vidíte - neztratí se to v moři textových změn.
Časté dotazy
Podporuješ GitHub Flavored Markdown?
Ano - tabulky, checkboxy (- [x]), strikethrough, automatické linkování URL. Většina věcí co funguje na GitHubu funguje i tady.
Co když mám v dokumentaci hodně kódu?
Kódové bloky (```) se správně rozpoznají a změny uvnitř se označí odděleně od okolního textu. Nemusíte se bát že se to pomíchá.
Jak to funguje s obrázky a odkazy?
Změny v syntaxi odkazů ([text](url)) a obrázků jsou vidět v diffu. V náhledu se zobrazí jako aktivní odkazy. Obrázky z externích URL se stáhnou a zobrazí.
Můžu sem dát interní dokumentaci firmy?
Celé porovnání běží lokálně v prohlížeči. Text nikam neodesílám, neukládám, nemám k němu přístup. Klidně sem dejte i citlivé interní dokumenty.
Víc o Markdown diffu
Na blogu mám článek o tom jak efektivně porovnávat dokumentaci - od README souborů až po wiki stránky. Plus pár tipů na strukturu dokumentů.
Přečíst článek o Markdown dokumentaci→Další nástroje pro porovnávání
Poznámka autora
Všechny poznámky, dokumentaci i blog píšu v Markdownu. Obsidian, iA Writer, VS Code - všude Markdown. Jenže když chci vidět co přesně jsem změnil od minulé verze, obyčejný diff nestačí.
Třeba změním nadpis z "# Instalace" na "# Jak nainstalovat" - v textovém diffu to vypadá jako dva úplně jiné řádky. Tady vidím že jde o nadpis a co přesně se v něm změnilo.
Náhled vedle diffu je bonus - nemusím mentálně překládat syntaxi. Vidím změnu v zdrojáku i jak bude vypadat ve výsledku.
Víc o práci s dokumentací píšu na blogu. Máte nápad na vylepšení? Napište mi přes kontaktní formulář.