A Markdown review gyakran egy gyakorlati kérdéssel zárul: hogyan osztható meg az eredmény valakivel, akinek nem a source-ot kell olvasnia? A raw Markdown jó szerzőknek és fejlesztőknek, de nem mindig ideális product managernek, ügyfélnek vagy reviewernek, aki csak a renderelt tartalmat szeretné ellenőrizni.
A Markdown-validátor most kompakt letöltési menüt ad az előnézethez. Innen a renderelt eredmény letölthető TXT, PDF vagy Word DOCX formátumban, miközben a source Markdown letöltése külön művelet marad a tényleges .md tartalomhoz.
Renderelt előnézet vagy source
Az előnézeti exportok sanitizált renderelt HTML-ből készülnek. A fájl azt a szöveget és struktúrát követi, amelyet az előnézeti panelen látsz, nem közvetlenül a raw Markdown source-ot. Ha a reviewer olvasóként nézi a címsorokat, bekezdéseket, táblázatokat vagy linkeket, az előnézeti export a megfelelő fájl. Ha fejlesztőnek kell commitolnia a source-ot, a Markdown download a pontosabb.
Melyik formátumot használd
- TXT gyors copy review-hoz, kereséshez, archiváláshoz vagy plain textet fogadó rendszerekhez hasznos.
- PDF akkor jobb, ha stabil fájl kell olvasáshoz, megosztáshoz vagy jóváhagyáshoz.
- Word DOCX akkor illik, ha editor vagy ügyfél kommenteket és szövegjavításokat vár dokumentumban.
Mi marad meg
Az exportok olvasható dokumentumot céloznak, nem pixel-perfect böngészős előnézetet. Megőrzik a címsorokat, bekezdéseket, listákat, táblázatokat, code blockokat, idézeteket, linkeket, image alt textet és az elérhető KaTeX szöveget.
A workflow rövid: illeszd be a Markdown-t, nézd át az előnézetet, javítsd a warnings jelzéseket, nyisd meg a letöltési menüt, majd válassz TXT, PDF vagy Word formátumot a következő reviewer alapján.
Szélesebb Markdown QA passhoz olvasd el, hogyan ismerhetők fel a Markdown-problémák publikálás előtt. Commit előtt hasznos a GitHub-flavored Markdown preview workflow. Csapatreviewhoz párosítsd a product és docs workflow-val.
