Een van de belangrijkste taken bij het maken van software is documentatie, helaas voor degenen onder ons die dit werk ontwikkelen, lijkt het soms vervelend, maar het is voor niemand een geheim dat goede documentatie het succespunt van een tool kan zijn, aangezien beide voor de hulp die aan gebruikers wordt gegeven om de juiste werking van de applicatie te begrijpen of de informatie die aan andere ontwikkelaars wordt verstrekt om deze te verbeteren.
Er zijn redelijk goede applicaties waarmee we onze projecten op een eenvoudige manier kunnen documenteren, sommige bieden meer dan we echt willen en andere vereisen complexe installaties, een tool om projecten te documenteren dat voldoet en vrij eenvoudig te gebruiken en te installeren is, is Docusaurus.
Wat is Docusaurus?
Docaurus is een project voor webdocumentatie voor open source tools bouwen, implementeren en onderhouden, het maakt het mogelijk om de taal te gebruiken Markdown Om de documentatie te schrijven die later als html-website zal worden gepubliceerd, stelt de tool ons op dezelfde manier in staat om het ontwerp van onze documentatiewebsite uit te breiden en aan te passen met behulp van React.
Over het algemeen stelt deze open source-tool, ontwikkeld door het Facebook-programmeerteam, ons in staat om eenvoudig mooie en lichte websites te maken waarop we de documentatie van elk project correct kunnen weergeven.
De tool is uitgerust met functionaliteiten voor de juiste versie van documenten, een geavanceerde zoekmachine, de mogelijkheid om onze documentatiesite in realtime te documenteren en opnieuw te ontwerpen, integratie met vertalingen en vele andere functies die u zullen helpen minder zorgen te maken over documenteren of liever het documentatieproces eenvoudiger en met een aangenamere afwerking.
Het gemakkelijke gebruik van Docusaurus is te zien in de volgende gif die door de ontwikkelaars wordt verspreid
Hoe installeer ik Docusaurus?
Het belangrijkste doel van Docusaurus is om het definitieve hulpmiddel te zijn voor het documenteren van open source-applicaties die op github worden gehost, dus het is heel eenvoudig om uw documentatiewebsite op dit platform te installeren en uit te voeren.
Om te beginnen met genieten van Docusaurus op Github, volg je gewoon de stappen die zijn aangegeven door het ontwikkelingsteam en die we hieronder citeren:
- Ga naar de root van je GitHub-repository-map waar je de documenten gaat maken en voer de volgende opdrachten uit:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
Het eindresultaat is het creëren van een bestand en een directorystructuur zoals hieronder weergegeven:
Interessante bug om te proberen!