Metadata-Version: 2.1
Name: Kart
Version: 0.16.0
Summary: A very flexible static site generator written in python
License: MIT
Author: Giacomo Caironi
Author-email: giacomo.caironi@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Provides-Extra: toml
Requires-Dist: aiohttp (>=3.9.3,<4.0.0)
Requires-Dist: jinja2 (>=3.1,<3.2)
Requires-Dist: mistune (>=3.0,<4.0)
Requires-Dist: pygments (>=2.6.1,<3.0.0)
Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
Requires-Dist: python-slugify (>=8.0,<9.0)
Requires-Dist: pyyaml (>=6.0,<7.0)
Requires-Dist: tomli (>=2.0.1,<3.0.0) ; extra == "toml"
Requires-Dist: watchfiles (>=0.21.0,<0.22.0)
Description-Content-Type: text/markdown

# Kart

A very flexible static site generator written in python

## Getting started

Install Kart with pip

```bash
pip install Kart
```

Build the basic structure

```bash
python -m kart init
```

In this configuration Kart will only build a basic blog with a paginated blog index and paginated tags.
If you want to customize the urls of the blog you will have to modify main.py with custom python code

You can then build and serve your site with this command

```bash
python3 main.py serve
```

## Disclaimer

Kart is not yet ready to use in a real-world scenario.
It is still in development its api can change abruptly each minor version.

I am currently writing the [documentation](https://kart.giacomocaironi.dev) of kart but it is by no mean complete.
If you want to look at some examples you can look the docs folder, where the documentation is held, and the source code of the [example site](https://gitlab.com/giacomocaironi/Kart/-/tree/master/kart_quickstart)

