KatApp Documentation

---

This repository contains the end user documentation for KatApp. It is intended to provide general instructions for users of the KatApp app and the KatApp dashboard.

It does not contain technical documentation. If you're interested in the technical details of the KatApp ecosystem, have a look at the separate repositories for the app, the dashboard and the backend.

---

Introduction

This documentation is built with hugo, an open-source static website generator.

Getting started

Development

To build and serve the documentation locally, an installation or an executable of hugo is required. For installation instructions, follow the official hugo manual.

To serve the site locally, run the following command:

$ hugo server --buildDrafts --cleanDestinationDir

Alternatively, you can use the launch task "Debug Hugo Docs" under VsCode.

Deploy

To build the site, run the following command:

$ hugo --gc --minify

Writing documentation

Contents

The documentation is written using Markdown. All the contents of the documentation site are located within the ./content directory.

The documentation is written only in English.

We use the open source Relearn theme for Hugo. You can find instructions on how to write and style Hugo pages on the official Hugo website or on the official website of the Relearn theme.