When we work on projects, whatever they have a huge number of features or simply they are exposed to the clients, we want to have them documented to help other devs or customers to be able to use it easily.
Often, this documentation is really small, put all other the place, lost in a middle of a Confluence... or it never exists!
So today we will see how Docusaurus will help us to manage this kind of issue.
What is Docusaurus?
Docusaurus is an open source project which helps to create a technical documentation from Markdown files.
Once compiled and deployed, you will have a static web site with contains all your documentation with a great presentation without losing time on configurations or deployment.
Why docusaurus?
Because it's principal objective is turned on the quick and simple creation of a technical documentation and not only a static web site!
Other tools (that I've talked about before) are more focused on creating a static web site or blog, but not a technical documentation, which makes it a huge difference.
For example, Docusaurus will display two navigation bars.
One on the left to display all the topics and subtopics of your documentation.
One on the right to display all the titles and subtitles of the current documentation page.
A simple feature which can make all the difference!
Some other useful features :
- search bar is directly integrated, you don't need to install an external plugin
- internationalisation is available and can easily be setup
- blog, if you want to post some articles about your project ...
I will stop here about all the features because there are a lot of them!
Conclusion
To end this post, Docusaurus is really a tool which must be tested because it has everything to simplify your life and create easily a documentation for all your projects.
Links
- Docusaurus : https://docusaurus.io/
I hope it will help you! 🍺
You want to support me?
Top comments (0)