Documents for developers are indispensable for talking about DX (Developer Experience. Developer Experience). The fact that the document is incorrect is out of the question, but there are elements that can be more readable and improve the experience in terms of functionality.
In the meantime, the ease of maintenance is also an important factor. This time we will introduce Docbase, a document system based on the Markdown file.
How to use Docbase
It is a usage example. The design of the top page is also cool.
Document details. The table of contents on the right side, contents are displayed in the center.
The code is bigger and easier to read.
An example of another document. You can customize headers and fonts. The right column is not displayed.
Docbase generates HTML based on the Markdown file. Basically it is 2 or 3 columns, and the table of contents is displayed on the left. Although there are not many functional aspects, it is characterized by high readability and beautiful.
Docbase is open source software (MIT License) made by node / JavaScript.
No comments:
Post a Comment