Today we would like to share an important update: all Stimulsoft documentation, including user guides for the report and dashboard generators as well as the report server, has been exported to the lightweight Markdown markup format. It is now also stored in public GitHub repositories.
Why was this done?
There are several reasons for exporting the documentation to Markdown. Here are the main ones:- format universality:
Markdown can be easily converted into other formats such as HTML, PDF, DOCX, and more; - improved readability:
It is a simple text format that is easy for both humans to read and machines to process; - сonvenient editing:
Markdown text can be easily edited in any text editor or IDE, as well as directly in a browser (for example, on GitHub).
In addition, this type of markup is convenient for recognition by AI agents, which can significantly simplify working with documentation for end users.
Below, you will find links to the documentation in Markdown format.
- Stimulsoft Reports & Dashboards User Manual
- Stimulsoft Reports & Dashboards Programming Manual
- Stimulsoft Server Manual
- Stimulsoft Server API Manual
- Stimulsoft Cloud API Manual
Additionally, on the Documentation page, you can find the same links, as well as online HTML and PDF versions.
Additionally
We have also introduced several smaller improvements designed to make working with the documentation more convenient:- the search functionality has been relocated;
- the ability to copy a documentation page as Markdown (without images) has been added;
- the ability to copy individual code blocks has been added;
- mobile adaptation has been implemented;
- support for both dark and light themes when viewing the documentation has been added.
If you have any further questions, feel free to contact us.