A szoftver létrehozásakor az egyik legfontosabb feladat a dokumentáció, sajnos azok számára, akik ezt a munkát fejlesztjük, néha unalmasnak tűnik, de senki számára sem titok, hogy a jó dokumentáció bármely eszköz sikerpontja lehet, hiszen az a segítség, amelyet a felhasználók kapnak az alkalmazás helyes működésének megértéséhez, vagy azokat az információkat, amelyeket más fejlesztőknek nyújtanak annak fejlesztése érdekében.
Vannak nagyon jó alkalmazások, amelyek lehetővé teszik számunkra, hogy projektjeinket egyszerű módon dokumentáljuk. Egyesek általában többet kínálnak, mint amit igazán szeretnénk, mások pedig összetett telepítéseket igényelnek, eszköz a projektek dokumentálásához amely megfelel és nagyon egyszerű használni és telepíteni a Docusaurus.
Mi az a Docusaurus?
Docusaurus projekt a nyílt forráskódú eszközök webdokumentációjának elkészítése, megvalósítása és karbantartása, lehetővé teszi a nyelv használatát Árleszállítás A később html webhelyként közzétett dokumentáció megírásához az eszköz lehetővé teszi számunkra, hogy a React használatával kibővítsük és testre szabhassuk dokumentációs weboldalunk kialakítását.
Általánosságban elmondható, hogy ez a nyílt forráskódú eszköz, amelyet a Facebook programozó csapat fejlesztett ki, lehetővé teszi számunkra, hogy szép és könnyű weboldalakat hozzunk létre, ahol bármely projekt dokumentációját megfelelően megjeleníthetjük.
Az eszköz fel van szerelve a dokumentumok helyes verziójának elkészítéséhez szükséges funkciókkal, egy fejlett keresőmotorral, a dokumentációs webhely valós idejű dokumentálásának és újratervezésének lehetőségével, a fordításokkal való integrációval és sok más olyan szolgáltatással, amelyek segítenek kevésbé aggódni a dokumentálás vagy inkább a készítés miatt a dokumentációs folyamat könnyebb és kellemesebb befejezéssel.
A Docusaurus egyszerű használata a következő gifben látható, amelyet a fejlesztői terjesztenek
Hogyan kell telepíteni a Docusaurus-t?
A Docusaurus fő célja, hogy meghatározó eszköz legyen a githubon tárolt nyílt forráskódú alkalmazások dokumentálásához, így nagyon egyszerű telepíteni és futtatni a dokumentációs webhelyet ezen a platformon.
Ahhoz, hogy élvezhesse a Docusaurus használatát a Githubon, kövesse a fejlesztői csapat által megadott lépéseket, amelyeket alább idézünk:
- Lépjen a GitHub tárház könyvtár gyökeréhez, ahol létrehozza a dokumentumokat, és futtatja a következő parancsokat:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
A végeredmény egy fájl- és könyvtárstruktúra létrehozása lesz, az alábbiak szerint:
Érdekes hiba kipróbálni!