Online ukážka Markdown a lokálna zostava dokumentov odpovedajú na rôzne otázky. Online ukážka sa pýta: "Vykresľuje sa tento Markdown čisto vo všeobecnom náhľade a existujú zjavné problémy s tvorbou?" Miestna zostava dokumentov sa pýta: "Funguje tento obsah v našom skutočnom dokumentačnom systéme?"
Obe sú užitočné. Chyba je v tom, že sa od jednej vrstvy žiada, aby vykonala prácu druhej vrstvy. Nástroj Markdown Validator spoločnosti Converty predstavuje rýchlu skorú kontrolu. Vaša lokálna zostava dokumentov zostáva konečnou kontrolou prostredia, keď záleží na vykresľovaní pre konkrétnu platformu.
Na rýchlu kontrolu konceptu použite online ukážku
Online náhľad Markdown je užitočný, keď sa obsah stále pohybuje. Sekciu README, poznámku k vydaniu, záznam v protokole zmien alebo podporný dokument možno skontrolovať skôr, ako sa z nich stane požiadavka na stiahnutie alebo zostavenie dokumentov.
Ukážka pomáha zachytiť:
- rozbité stoly
- problémy so štruktúrou nadpisov
- chýba alternatívny text
- prázdne odkazy
- neoznačené kódové ploty
- nespracovaný kód HTML, ktorý si vyžaduje kontrolu
Toto je fáza, v ktorej je rýchla spätná väzba dôležitejšia ako úplná presnosť prostredia.
Na konečné vykreslenie použite lokálnu zostavu dokumentov
Lokálna zostava dokumentov je tou správnou vrstvou, keď má finálna platforma vlastné správanie. Mnoho systémov dokumentov transformuje Markdown prostredníctvom komponentov, smerovania, zvýraznenia syntaxe, vlastných popisov alebo štýlu špecifického pre rámec.
Iba lokálna zostava môže ukázať, či obsah v danom prostredí funguje. Ak stránka používa vlastné komponenty, importované úryvky alebo vykresľovanie špecifické pre daný produkt, ukážka prehliadača by mala byť prvá, nie posledná.
Najlepší pracovný postup využíva oboje
Na vyčistenie zdroja použite online náhľad. Na overenie cieľa použite lokálnu zostavu.
Táto sekvencia šetrí čas, pretože lokálna zostava už nezachytáva základné chyby Markdown. Môže sa zamerať na správanie špecifické pre platformu, ktoré dokáže jedinečne otestovať.
Praktický pracovný postup včasnej kontroly nájdete v časti Ako zobraziť ukážku GitHub-Flavored Markdown predtým, ako ju vykonáte. Informácie o odovzdávaní produktov a dokumentov si prečítajte v časti Ako môžu tímy produktov a dokumentov kontrolovať Markdown bez straty formátovania.
Pred presunutím rovnakého obsahu do lokálnej zostavy dokumentov alebo finálnej ukážky zverejnenia otvorte Overenie známok, keď potrebujete rýchlu vrstvu s ukážkou online.
