Static Documentation Generators
Hi Community,
In the past, technical documentation of the source code and software products was generated in chm, pdf files and documentation generators of the programming languages themselves. This old approach had the following limitations:
1. Outdated documentation;
2. Non-interactive and difficult to consult documentation;
3. Layout unresponsive, unfriendly and not adherent to HTML;
4. Inability to customize the layout of the documentation;
5. Inability to have HTML 5 documentation online and offline.
6. Lack of Markdown support.
Today, there are several documentation generation solutions that produce Web Documentation Portals that are very attractive, interactive, responsive and with static and dynamic options, with full support for HTML 5 and more recently Markdown.
See the table with the most popular open source options:
Documentation Product | Stars |
MkDocs
|
11.4k |
Docsify Github Repo: https://github.com/docsifyjs/docsify
|
16.5k |
Docusaurus Github: https://github.com/facebook/docusaurus/
|
21.4k |
Slate Github: https://github.com/slatedocs/slate
|
31.9k |
GitBook
|
500,000 users |
The IRIS Publisher in the Open Exchange allows you extract XData documentation blocks in HTML or Markdown and generate your app documentation website using MkDocs. See the instructions in the article: https://community.intersystems.com/post/creating-documentation-portal-your-intersystems-iris-application.
If you enjoyed, vote in my app: https://openexchange.intersystems.com/contest/current
Ref: https://dev.to/nafis/5-free-static-documentation-generators-you-must-che...
Great!
I'd also add GitBook to the list.
Great, I will include, but gitbook is a cloud solution and it is free
only for personal projects, limited to 10 spaces. The solutions above
are free to business projects and with on-premises option
Their cloud hosting is not free but you can host it yourself.
The legacy version or current version can be hosted?
Legacy.