Get started
This documentation will guide you through the usage of ArmoniK Docs Theme from installation to deployment and customization.
A lot of docs
ArmoniK is an open-source project composed by more that 10 repositories but each of them needs a documentation. In the same time, developers deserve a tool to ease the process of writing documentation because there is a lot to write.
To achieve this goal, developers needed:
- Ready to use documentation
- Markdown support
- Easy to customize
- Live preview of changes
- Easy to deploy
A theme to unified
The first step was to find a way to unified all the documentation and the developer experience across all the repositories.
The solution was to create a theme that can be used across every documentation but maintain in a single repository. To achieve this goal, we decided to use Docus as a base for the theme.
What is Docus?
This theme, called ArmoniK Docs Theme, is a layer on top of Docus to add features, components and customization specific to ArmoniK.
What's underneath ArmoniK Docs Theme?