Online Markdown-forhåndsvisning og en lokal dokumentbygging svarer på forskjellige spørsmål. En forhåndsvisning på nettet spør: "Gjøres denne Markdown rent i en generell forhåndsvisning, og er det åpenbare forfatterproblemer?" En lokal dokumentbygging spør: "Funker dette innholdet i vårt faktiske dokumentasjonssystem?"
Begge er nyttige. Feilen er å be det ene laget gjøre jobben til det andre laget. Convertys Markdown Validator er en rask tidlig sjekk. Din lokale dokumentbygging forblir den siste miljøkontrollen når plattformspesifikk gjengivelse er viktig.
Bruk online forhåndsvisning for rask gjennomgang av utkast
En online Markdown-forhåndsvisning er nyttig når innholdet fortsatt er i bevegelse. En README-del, utgivelsesnotat, endringsloggoppføring eller støttedokument kan sjekkes før det blir en pull-forespørsel eller dokumentbygging.
Forhåndsvisningen hjelper med å fange opp:
- ødelagte bord
- problemer med overskriftsstruktur
- mangler alt-tekst
- tomme lenker
- umerkede kodegjerder
- rå HTML som trenger gjennomgang
Dette er stadiet hvor rask tilbakemelding betyr mer enn full miljønøyaktighet.
Bruk en lokal dokumentbygging for endelig gjengivelse
En lokal dokumentbygging er det riktige laget når den endelige plattformen har tilpasset oppførsel. Mange dokumentsystemer transformerer Markdown gjennom komponenter, ruting, syntaksutheving, egendefinerte bildetekster eller rammespesifikk stil.
Bare det lokale bygget kan vise om innholdet fungerer i det miljøet. Hvis en side bruker egendefinerte komponenter, importerte kodebiter eller produktspesifikk gjengivelse, bør forhåndsvisningen av nettleseren komme først, ikke sist.
Den beste arbeidsflyten bruker begge
Bruk online forhåndsvisning for å rense kilden. Bruk den lokale versjonen for å bekrefte destinasjonen.
Denne sekvensen sparer tid fordi den lokale konstruksjonen ikke lenger fanger opp grunnleggende Markdown-feil. Den kan fokusere på den plattformspesifikke oppførselen den er unikt i stand til å teste.
For en praktisk arbeidsflyt for tidlig gjennomgang, les Hvordan forhåndsvise GitHub-Flavored Markdown før du forplikter deg. For overleveringer av produkter og dokumenter, les Hvordan produkt- og dokumentteam kan gjennomgå Markdown uten å miste formatering.
Åpne Markdown Validator når du trenger det raske forhåndsvisningslaget på nettet før du flytter det samme innholdet til en lokal dokumentbygging eller endelig publiseringsforhåndsvisning.
