Ceann de na tascanna is tábhachtaí agus bogearraí á gcruthú is ea cáipéisíocht, ar an drochuair dóibh siúd againn a fhorbraíonn an obair seo uaireanta bíonn cuma slachtmhar air, ach ní rún é do dhuine ar bith gur féidir le doiciméadacht mhaith a bheith mar phointe rathúlachta aon uirlis, ós rud é Ceachtar don cabhair a thugtar d’úsáideoirí chun oibriú ceart an fheidhmchláir nó an fhaisnéis a chuirtear ar fáil d’fhorbróirí eile a thuiscint chun é a fheabhsú.
Tá feidhmchláir an-mhaith ann a ligeann dúinn ár dtionscadail a dhoiciméadú ar bhealach simplí, bíonn claonadh ag cuid acu níos mó a thairiscint ná mar a theastaíonn uainn i ndáiríre agus teastaíonn suiteálacha casta ó chuid eile, a. uirlis chun tionscadail a dhoiciméadú is é Docusaurus a chomhlíonann agus atá simplí go leor le húsáid agus le suiteáil.
Cad é Docusaurus?
Docusaurus Is tionscadal do cáipéisíocht gréasáin uirlisí foinse oscailte a thógáil, a chur i bhfeidhm agus a chothabháil, ceadaíonn sé an teanga a úsáid Markdown Chun an cháipéisíocht a fhoilseofar níos déanaí mar shuíomh Gréasáin html a scríobh, ar an mbealach céanna, tugann an uirlis deis dúinn dearadh ár suíomh Gréasáin doiciméadaithe a leathnú agus a shaincheapadh trí React a úsáid.
Go ginearálta, tugann an uirlis foinse oscailte seo a d’fhorbair foireann ríomhchlárúcháin Facebook deis dúinn láithreáin ghréasáin áille agus éadroma a chruthú inar féidir linn cáipéisíocht aon tionscadail a thaispeáint i gceart.
Tá an uirlis feistithe le feidhmiúlachtaí maidir le leagan amach ceart doiciméad, inneall cuardaigh ardleibhéil, an fhéidearthacht ár suíomh doiciméadaithe a dhoiciméadú agus a athdhearadh i bhfíor-am, comhtháthú le haistriúcháin agus go leor gnéithe eile a chabhróidh leat níos lú a bheith buartha faoi dhoiciméadú nó in áit é a dhéanamh an próiseas doiciméadaithe níos éasca agus le bailchríoch níos taitneamhaí.
Is féidir úsáid éasca Docusaurus a fheiceáil sa gif seo a leanas arna dháileadh ag a fhorbróirí
Conas Docusaurus a shuiteáil?
Is é príomhchuspóir Docusaurus a bheith mar uirlis dheifnídeach chun feidhmchláir foinse oscailte a óstáiltear ar github a dhoiciméadú, mar sin tá sé an-éasca do shuíomh Gréasáin doiciméadaithe a shuiteáil agus a rith ar an ardán seo.
Chun taitneamh a bhaint as Docusaurus ar Github, lean na céimeanna a léirigh an fhoireann forbartha agus luaimid thíos iad:
- Téigh go dtí fréamh do eolaire stór GitHub áit a gcruthóidh tú na doiciméid agus rithfidh tú na horduithe seo a leanas:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Is é an toradh deiridh a bheidh air struchtúr comhad agus eolaire a chruthú mar a thaispeántar thíos:
A comment, fág mise
Fabht suimiúil le triail!