Online Markdowni eelvaade ja kohalik dokumentide koostamine vastavad erinevatele küsimustele. Interneti-eelvaade küsib: "Kas see Markdown renderdub üldises eelvaates puhtalt ja kas autoril on ilmseid probleeme?" Kohalik dokumentide järg küsib: "Kas see sisu töötab meie tegelikus dokumentatsioonisüsteemis?"
Mõlemad on kasulikud. Viga on selles, et ühel kihil palutakse teha teise kihi töö. Converty Markdown Validator on kiire varajane kontroll. Teie kohalik dokumentide järg jääb lõplikuks keskkonnakontrolliks, kui platvormipõhine renderdamine on oluline.
Kasutage mustandi kiireks ülevaatamiseks veebipõhist eelvaadet
Veebipõhine Markdowni eelvaade on kasulik siis, kui sisu veel liigub. README jaotist, väljalaskemärkust, muudatuste logi kirjet või tugidokumenti saab kontrollida enne, kui sellest saab tõmbetaotlus või dokumentide järg.
Eelvaade aitab tabada:
- katkise välimusega lauad
- pealkirja struktuuri probleemid
- puudub alternatiivtekst
- tühjad lingid
- märgistamata koodaiad
- töötlemata HTML, mis vajab ülevaatamist
See on etapp, kus kiire tagasiside on olulisem kui täielik keskkonnatäpsus.
Kasutage lõplikuks renderdamiseks kohalikku dokumentide järgu
Kohalik dokumentide järg on õige kiht, kui lõplikul platvormil on kohandatud käitumine. Paljud dokumendisüsteemid muudavad Markdowni komponentide, marsruutimise, süntaksi esiletõstmise, kohandatud tähelepanulaiendite või raamistikuspetsiifilise stiili abil.
Ainult kohalik järg saab näidata, kas sisu selles keskkonnas töötab. Kui leht kasutab kohandatud komponente, imporditud katkendeid või tootepõhist renderdamist, peaks brauseri eelvaade olema esimene, mitte viimane.
Parim töövoog kasutab mõlemat
Kasutage allika puhastamiseks veebipõhist eelvaadet. Kasutage sihtkoha kinnitamiseks kohalikku järgu.
See jada säästab aega, sest kohalik ehitamine ei taba enam põhilisi Markdowni vigu. See võib keskenduda platvormispetsiifilisele käitumisele, mida ta on ainulaadselt võimeline testima.
Praktilise varajase ülevaatuse töövoo jaoks lugege artiklit Kuidas vaadata eelvaadet GitHub-Flavored Markdown enne selle rakendamist. Toodete ja dokumentide üleandmise kohta lugege artiklit Kuidas toote- ja dokumentide tiimid saavad allahindlust üle vaadata ilma vormindamist kaotamata.
Avage Markdown Validator, kui vajate kiiret veebipõhist eelvaate kihti enne sama sisu teisaldamist kohalikku dokumentide järgusse või lõplikku avaldamise eelvaatesse.
