Documentation

Documentation is created with MkDocs using Material for MkDocs. MkDocs is configured with mkdocs.yml and documentation source is stored in the docs folder.

Install Python

Download and install the latest version of Python.

macOS

Using Homebrew

brew install python

Windows

Download and install the recommended version from python.org.

Or with Chocolatey

choco install python

Install MkDocs and plugins

Open a new Terminal or Command Prompt window.

pip install mkdocs mkdocs-material mkdocs-markdownextradata-plugin

For more information see the MkDocs Installation Guide and the Material for MkDocs Installation Guide.

Writing Documentation

Documentation source files are written in Markdown. For navigation and advanced formatting features, see the MkDocs Writing your docs guide and Material for MkDocs Reference.

Variables

Some dynamic variables are made available, they can be used with the {{ name }} syntax. Below are the available variables.

Name	Value
project	The project name for the repository
lib_version	The current release version, for example `2.3.5` (No `v` prefix)

View docs locally

To view the docs locally, open a terminal or command prompt and cd into your KtSoup folder then run

mkdocs serve

Your changes will be served at http://127.0.0.1:8000. After saving changes, the webpage will reload automatically.

Deployment

Changes are deployed automatically for tagged releases.