Welcome to the repository for the Katson.com Documentation. This documentation is built using MkDocs and the Material for MkDocs theme. It provides comprehensive information on how to use Katson.com apps.
This documentation covers Katson.com apps, including installation, configuration, usage, limitations, architecture, and security etc.
To get started with this documentation:
-
Clone the Repository:
git clone https://github.com/katson-com/docs.git
-
Install MkDocs: Install MkDocs and the Material theme. If you haven't installed MkDocs, see the MkDocs installation guide.
-
Install Dependencies: Navigate to the cloned directory and install the required dependencies:
pip install -r requirements.txt
-
Run Locally: Start the MkDocs development server:
mkdocs serve
This will make the documentation available at
http://127.0.0.1:8000/.
This documentation is automatically deployed to GitHub Pages upon merging to the main branch.