Bíonn fadhbanna Markdown furasta a chailleadh sa téacs amh: ceannteideal a léimeann leibhéal, nasc folamh, alt text in easnamh, nó fál cód gan teanga. Ní bhíonn siad tromchúiseach ina n-aonar, ach is féidir leo doiciméid, nótaí eisiúna agus ábhar CMS a dhéanamh níos deacra a fhoilsiú.
Comhcheanglaíonn Bailíochtóir Markdown Converty réamhamharc beo GitHub-flavored Markdown le rabhaidh údaraithe phraiticiúla. Ní córas lint trom é; is pas tapa réamhfhoilsithe é chun na fadhbanna soiléire a ghlanadh agus an téacs fós éasca le hathrú.
Tosaigh leis an réamhamharc, mar is fusa fabhtanna formáidithe a fheiceáil ná a shamhlú
Ní insíonn an Markdown amh duit i gcónaí cén chuma a bheidh ar an aschur. Is féidir le tábla breathnú ceart sa téacs agus a bheith deacair a léamh sa rindreáil. Is féidir le blocchód, liosta nó bloc-athfhriotail fadhb spásála a cheilt go dtí go bhfeiceann tú an leagan deiridh.
Sin é an fáth gur cheart an réamhamharc a úsáid go luath. Léiríonn sé ceannteidil, liostaí, táblaí agus cód i gcomhthéacs sula mbogann an t-ábhar go GitHub, CMS nó leathanach docs.
Tá bailíochtú tábhachtach mar go mbíonn roinnt botún dofheicthe sa réamhamharc
Ní leor réamhamharc leis féin. D’fhéadfadh nasc a bheith folamh ach fós gan mórán cuma a chur ar an leathanach. D’fhéadfadh íomhá gan alt text breathnú ceart ach drochthaithí inrochtaineachta a chruthú. D’fhéadfadh H1 dúblach struchtúr an leathanaigh a chur as ord.
Cuireann liosta rabhaidh na fadhbanna sin ar aghaidh ionas gur féidir leat iad a dheisiú roimh fhoilsiú.
Sreabhadh réalaíoch do nótaí eisiúna nó nuashonruithe docs
- Greamaigh an draft isteach sa Bailíochtóir Markdown.
- Seiceáil an réamhamharc rindreáilte.
- Léigh na rabhaidh faoi cheannteidil, naisc, íomhánna agus fálta cód.
- Ceartaigh an fhoinse.
- Déan pas deireanach sa chóras cinn scríbe.
Ní ionadaíonn sé seo athbhreithniú GitHub nó CMS, ach baintear an glantachán bunúsach den bhealach sula mbíonn an córas foilsithe ina chéad reviewer agat.
Is ag HTML amh a gcaithfidh cúram agus praiticiúlacht teacht le chéile
Ceadaíonn Markdown HTML inlíne i go leor sreafaí. Tá sé sin úsáideach, ach níor cheart do réamhamharc poiblí muinín dall a chur i scriptí, handlers nó prótacail neamhshábháilte. Sláintíonn Converty HTML amh sa réamhamharc ionas gur féidir leat an t-aschur a thuiscint gan iompar contúirteach a chur i bhfeidhm.
Má tá tú ag meas an mbaineann ábhar íogair le huirlis bhrabhsálaí ar chor ar bith, léigh An bhfuil tiontairí ar líne sábháilte do chomhaid oibre?.
Cad is fearr leis an liosta rabhaidh a aimsiú
Tá an liosta úsáideach do rudaí a bhíonn éasca a dhearmad:
- léimeanna ceannteidil
- H1 dúblach
- íomhánna gan alt text
- naisc fholmha
- fálta cód gan teanga
- HTML amh a dteastaíonn cúram uaidh
Níor cheart dó an t-alt a athscríobh duit. Ba cheart dó na háiteanna a thaispeáint ina bhféadfadh struchtúr nó inrochtaineacht dul as a riocht.
Cathain is leor seiceáil sa bhrabhsálaí agus cathain nach leor
Is leor seiceáil sa bhrabhsálaí nuair atá tú ag glanadh draft, nótaí eisiúna, doiciméad beag nó réimse CMS sula gcuirtear isteach é. Ní leor í nuair atá rialacha foilsithe casta, macros saincheaptha nó build docs iomlán i gceist.
Is é an gnáthord maith: glan na botúin údaraithe ar dtús, ansin déan athbhreithniú atá feasach ar an gceann scríbe. Clúdaíonn Conas is féidir le foirne doiciméadaithe Markdown a bhailíochtú roimh fhoilsiú ar GitHub nó i CMS an cás docs níos leithne.
Aimsigh na fadhbanna soiléire sula mbíonn siad ina bhfadhb ag duine eile
Is fearr botún Markdown a aimsiú agus an téacs fós sa draft ná é a aimsiú tar éis dó dul isteach i gcóras foilsithe. Oscail an Bailíochtóir Markdown, greamaigh an t-ábhar agus glan na rabhaidh. Má tá an obair mar chuid de sheoladh níos mó ina bhfuil slugs agus favicons freisin, léigh Conas is féidir le foirne ábhar slugs, Markdown agus favicons a ullmhú do sheoladh nua.
