Az online Markdown előnézet és a helyi dokumentumok összeállítása különböző kérdésekre válaszol. Egy online előnézet megkérdezi: "Tisztán jelenik meg ez a Markdown az általános előnézetben, és vannak nyilvánvaló szerzői problémák?" Egy helyi docs build megkérdezi: "Működik ez a tartalom a tényleges dokumentációs rendszerünkön belül?"
Mindkettő hasznos. A hiba az, hogy megkérjük az egyik réteget, hogy végezze el a másik réteg munkáját. A Converty Markdown Validator egy gyors korai ellenőrzés. A helyi dokumentumok buildje marad az utolsó környezeti ellenőrzés, amikor a platformspecifikus megjelenítés számít.
Használja az online előnézetet a vázlat gyors áttekintéséhez
Az online Markdown előnézet akkor hasznos, ha a tartalom még mozog. A README szakaszt, kiadási megjegyzést, változásnapló-bejegyzést vagy támogatási dokumentumot ellenőrizni lehet, mielőtt lekérési kéréssé vagy dokumentumok felépítésévé válna.
Az előnézet segít elkapni:
- törött kinézetű asztalok
- címsorszerkezeti problémák
- hiányzik az alternatív szöveg
- üres linkek
- címkézetlen kódos kerítések
- nyers HTML, amelyet felül kell vizsgálni
Ez az a szakasz, ahol a gyors visszajelzés többet számít, mint a teljes környezeti pontosság.
Használjon helyi docs buildet a végső megjelenítéshez
A helyi dokumentumok build a megfelelő réteg, ha a végső platform egyéni viselkedést mutat. Sok dokumentumrendszer átalakítja a Markdownt összetevők, útválasztás, szintaxiskiemelés, egyéni kiemelések vagy keretspecifikus stílusok segítségével.
Csak a helyi build tudja megmutatni, hogy a tartalom működik-e az adott környezetben. Ha egy oldal egyéni összetevőket, importált kivonatokat vagy termékspecifikus megjelenítést használ, a böngésző előnézetének kell az első, nem pedig az utolsónak lennie.
A legjobb munkafolyamat mindkettőt használja
Használja az online előnézetet a forrás megtisztításához. Használja a helyi buildet a cél ellenőrzéséhez.
Ez a sorrend időt takarít meg, mert a helyi build már nem képes az alapvető Markdown hibákat észlelni. Arra a platform-specifikus viselkedésre összpontosíthat, amelyet egyedülállóan tesztelhet.
A gyakorlati korai felülvizsgálat munkafolyamatához olvassa el a Hogyan tekintse meg az előnézetet GitHub-Flavored Markdown, mielőtt elkötelezi magát című részt. A termékek és dokumentumok átadásával kapcsolatban olvassa el a Hogyan tekinthetik át a termék- és dokumentumcsapatok a formázás elvesztése nélkül című részt.
Nyissa meg a Markdown Validator alkalmazást, amikor szüksége van a gyors online előnézeti rétegre, mielőtt áthelyezné ugyanazt a tartalmat egy helyi dokumentumok buildbe vagy végleges közzétételi előnézetébe.
