One of the most important tasks when creating software is documentation, unfortunately for those of us who develop this work sometimes it seems tedious, but it is no secret to anyone that good documentation can be the point of success of any tool, since Either because of the help that is given to users to understand the correct operation of the application or the information that is provided to other developers to improve it.
There are quite good applications that allow us to document our projects in a simple way, some tend to offer more than what we really want and others require complex installations, a tool to document projects that complies and is quite simple to use and install is Docusaurus.
What is Docusaurus?
Docusaurus is a project for build, implement, and maintain open source tools web documentation, it allows to use the language Markdown To write the documentation that will later be published as an html website, in the same way, the tool allows us to extend and customize the design of our documentation website with the use of React.
Generally speaking, this open source tool developed by the Facebook programming team allows us to easily create beautiful and light websites where we can properly display the documentation of any project.
The tool is equipped with functionalities for the correct versioning of documents, an advanced search engine, the possibility of documenting and redesigning our documentation site in real time, integration with translations and many other features that will help you worry less about documenting or rather for making the documentation process easier and with a more pleasant finish.
The easy use of Docusaurus can be seen in the following gif distributed by its developers
How to install Docusaurus?
Docusaurus's main objective is to be the definitive tool for documenting open source applications hosted on github, so it is really easy to install and run your documentation website on this platform.
To start enjoying Docusaurus on Github, just follow the steps indicated by the development team and that we quote below:
- Go to the root of your GitHub repository directory where you will create the documents and run the following commands:
yarn global add docusaurus-initornpm install --global docusaurus-initdocusaurus-init
The end result will be the creation of a file and directory structure as shown below:
Interesting bug to try!