Сегодня мы расскажем о важном обновлении: вся документация Stimulsoft, включая руководства для пользователей по генераторам отчетов и дашбордов, а также серверу отчетов, экспортирована в облегченный формат разметки Markdown и хранится теперь, в том числе, в публичных репозиториях GitHub.
Для чего это сделано?
Причин экспорта документации в Markdown несколько, выделим основные:- универсальность формата:
Markdown можно легко конвертировать в другие форматы: HTML, PDF, DOCX и прочие; - улучшение читаемости:
Простой текстовый формат как для чтения человеком, так и для машинного распознавания; - удобное редактирование:
С markdown-текстом легко работать в любом текстовом редакторе или IDE, а также прямо в браузере (например на GitHub).
Кроме того, этот тип разметки удобен для распознавания ИИ-агентами, что может существенно упростить работу с документацией для простых пользователей.
Ниже приведены ссылки на документацию в формате Markdown.
- Stimulsoft Reports & Dashboards User Manual
- Stimulsoft Reports & Dashboards Programming Manual
- Stimulsoft Server Manual
- Stimulsoft Server API Manual
- Stimulsoft Cloud API Manual
Кроме того, на странице Документация можно найти те же ссылки, а также версии онлайн в HTML и в формате PDF.
Дополнительно
Еще несколько небольших изменений, призванных сделать работу с документацией более удобной:- перенесен поиск;
- появилась возможность скопировать страницу документации как Markdown (без картинок);
- возможность скопировать отдельно блок кода;
- добавлена мобильная адаптация;
- добавлена возможность использования темной и светлой темы при просмотре документации.
Если у вас остались вопросы, напишите нам.