Devdoc-Swissknife-Ru
2022-05-15
Вступление
Этот проект демонстрирует подход к созданию документации на разработку с помощью R Markdown и Kroki.
Всё то, что описано в данном в проекте, можно было делать и прежде, но я попытался увязать вместе эти компоненты так, чтобы можно было сосредоточить усилия на содержательной части документации.
Данный подход позволяет создавать документацию в виде файлов PDF, презентаций, сайта документтации по шаблону gitbook и в некоторых других форматах, используя для этого текстовые файлы с синтаксисом markdown (Pandoc flavor) и дополнительными вставками кода на языке R, а так же текстовые описания разного рода диаграмм.
Целью этого проекта является создание документации, максимально используя для этого текстовый формат, в т.ч. для описания графических диаграмм, но при этом без излишних переусложнений.
На данный момент рускоязычная документация устарела и нуждается в переработке. Посмотрите англоязычный вариант пока работа ещё не завершена.