Преглед онлајн Маркдовн-а и локални документи одговарају на различита питања. Преглед на мрежи поставља питање: „Да ли се овај Маркдовн јасно приказује у општем прегледу и да ли постоје очигледни проблеми са ауторима?“ Локална верзија докумената пита: „Да ли овај садржај функционише унутар нашег стварног система документације?“
Оба су корисна. Грешка је тражење од једног слоја да уради посао другог слоја. Цонверти-јев Маркдовн Валидатор је брза рана провера. Ваша локална верзија докумената остаје последња провера окружења када је рендеровање специфично за платформу битно.
Користите преглед на мрежи за брзи преглед нацрта
Преглед Маркдовн на мрежи је користан када се садржај још увек креће. РЕАДМЕ одељак, белешка о издању, унос у дневнику промена или документ за подршку могу се проверити пре него што постане захтев за повлачење или грађење докумената.
Преглед помаже да се ухвати:
- столови сломљеног изгледа
- питања структуре наслова
- недостаје алтернативни текст
- празне везе
- неозначене кодне ограде
- сирови ХТМЛ који треба прегледати
Ово је фаза у којој су брзе повратне информације важније од пуне тачности окружења.
Користите локалну израду докумената за коначно приказивање
Локална верзија докумената је прави слој када коначна платформа има прилагођено понашање. Многи системи докумената трансформишу Маркдовн путем компоненти, рутирања, истицања синтаксе, прилагођених облачића или стилова специфичних за оквир.
Само локална верзија може да покаже да ли садржај функционише у том окружењу. Ако страница користи прилагођене компоненте, увезене исечке или приказивање специфично за производ, преглед прегледача треба да буде први, а не последњи.
Најбољи ток посла користи обоје
Користите преглед на мрежи да бисте очистили извор. Користите локалну верзију да бисте потврдили одредиште.
Тај редослед штеди време јер локална верзија више не хвата основне Маркдовн грешке. Може се фокусирати на понашање специфично за платформу које је јединствено у стању да тестира.
За практичан радни ток раног прегледа, прочитајте Како прегледати GitHub-Flavored Markdown пре него што то учините. За примопредаје производа и докумената прочитајте Како тимови за производе и документе могу да прегледају маркдовн без губитка форматирања.
Отворите Маркдовн Валидатор када вам је потребан слој за брзи онлајн преглед пре него што преместите исти садржај у локалну верзију докумената или коначни преглед објављивања.
