Docusaurus
Author: Emir Olgun
Date: 7 March 2023
Introduction
Docusaurus is a static-site generator. It seems very useful because Markdown files can be posted on it. The tool looks like a promising tool for DAOs because it is almost effortless to create Documents and can be used by non-technical people easily.
How to Use Docusaurus
Docusaurus has a 5 minute gamified tutorial. In order to play it you need node.js on your computer. You can download the lasest version of node.js for your OS. To try the demo you need to interact with the terminal of your computer. For basic terminal commands please check here.
If you are on a Mac, Press Command+Space Bar and type terminal and you are in the terminal.
If you are on a windows, you can search for powershell on the Search and run.
If you are on Linux, you know what to do. :upside_down_face:
After node.js is successfully installed, run the command below in your terminal. to create your Docusaurus demo site.
To start the site:
After these commands, go to your favorite browser and type http://localhost:3000 and you can follow the tutorial on the website that opens up.
More detailed documentation can also be found here.
What Docusaurus Does
Docusaurus is a platform built with React. You can publish markdown docs and markdown blogs. It is customizable if you are familiar with JS and HTML. The website by default has a sidebar that shows the folders and documents similar to what Obsidian does. Nested Folders are supported. The top bar can provide different pages so you can have a blog page, a document page and more. Creating mor pages and new sidebars requires editing Javascript scripts so there is a need for a technical understanding.
Comparison to Obsidian
Docusaurus and Obsidian are quite similar. Both platforms provide static websites for publishing markdown documents. The advantage of obsidian is it provides the user with a platform to write, edit and organize the documents, the writer can see the effects of their work instantly. On the other hand, docusaurus does not have a platform and writing, editing and organizing the documents. So the user has to deal with other tools to write their documents and manually organize them in their OS' explorer, then use the terminal. Docusaurus interface is much more clear by default and easy to track. Currently in Obsidian, as you read more and more documents, the tabs can be overwhelming. Linking other documents in Docusaurus is more challenging than Obsidian. To put a link to another document in your website, you have to put directory path of it to the link, in Obsidian doing the same thing only requires typing the documents name.
Importance for DAOs
Docusaurus stands as a pivotal tool for DAOs primarily because of its capability to foster organized, accessible, and transparent documentation. DAOs, being decentralized entities, necessitate comprehensive documentation frameworks to elucidate their governance structures, tokenomics, and operational guidelines. Docusaurus seamlessly integrates with platforms like GitHub, promoting decentralized collaboration – a hallmark of DAOs. Its versioning support ensures that as DAOs evolve, their historical documentation remains intact and accessible, emphasizing transparency and showcasing the evolutionary journey of the organization.
Moreover, the global nature of DAOs demands tools that cater to a diverse audience. Docusaurus meets this need through its localization features, allowing for multilingual documentation that engages members from various cultural backgrounds. Additionally, its integrated blog support acts as a conduit for continuous communication, keeping the DAO community informed and engaged. In an era where transparency, collaboration, and community engagement are paramount for decentralized entities, Docusaurus emerges as an indispensable asset for DAOs, providing a structured and interactive platform for knowledge dissemination.
Conclusion
Docusaurus is a very useful tool to create a documentation website. It brings down the technical barrier of making a website significantly and gives a very good customization potential for technical people at the same time.
Additional Links
Last updated