Metadata-Version: 2.1
Name: Kart
Version: 0.3.0
Summary: A very flexible static site generator written in python
Home-page: https://github.com/giacomocaironi/Kart
Author: Giacomo Caironi
Author-email: giacomo.caironi@gmail.com
License: UNKNOWN
Description: # Kart
        A very flexible static site generator written in python
        
        # Getting started
        Install Kart with pip
        ```bash
        pip install Kart
        ```
        Create a new file named main.py in your top directory with this code
        ```python
        from kart import Kart
        
        kart = Kart()
        kart.run()
        ```
        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
        
        For the folder structure you can look at the test_blog example
        
        You can then build and serve your site executing this script
        ```bash
        python3 main.py serve
        ```
        # Disclaimer
        Kart is not yet ready to use in a real-world scenario because it is in its early stage of its life and its api can change abruptly each minor verision.
        
        I am currently writing the [documentation](https://giacomocaironi.github.io/Kart) of kart but it is by no mean complete. If you want to know how to use Kart in the meantime you can look at the docs folder, where the documentation is held, and the the source code of [my personal site](https://giacomocaironi.github.io) which is generated using kart
        
        # Missing features
        
        * The built-in dev server doesn't auto update the site when you modify the source, but you have to stop it and restart it to apply the changes.
        
        * the feed generation can only be applied to posts for now and is not very precise
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
