Metadata-Version: 2.4
Name: cambium
Version: 0.1.1
Summary: A light touch markdown static site generator
License-Expression: MIT
License-File: LICENSE
Author: Sidrat Research
Author-email: info@sidratresearch.com
Requires-Python: >=3.11
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
Classifier: Topic :: Text Processing :: Markup :: Markdown
Classifier: Topic :: Text Processing :: Markup :: HTML
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Content Management System
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: marko (>=2.2.2,<3.0.0)
Requires-Dist: pyyaml (>=6.0.3,<7.0.0)
Requires-Dist: typer (>=0.25.1,<0.26.0)
Project-URL: Homepage, https://github.com/sidratresearch/cambium
Project-URL: Issues, https://github.com/sidratresearch/cambium/issues
Description-Content-Type: text/markdown

# Cambium, A Light Touch Markdown Static Site Generator

![Static Badge](https://img.shields.io/badge/status-pre--alpha-orange)
![PyPI - Version](https://img.shields.io/pypi/v/cambium)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cambium)
![PyPI - License](https://img.shields.io/pypi/l/cambium)

A Python-based static site generator for repositories of organized markdown pages.

**This package is under active development and is pre-alpha. Please use with caution.**

## Why Use Cambium?

- Do you have a bunch of markdown files that you'd like to turn into a static site?
- Do you want to create a rapidly-changing wiki, knowledge base or documentation site that can be hosted without worrying about server requirements?
- Do you want to manage your documents using tools you already know and love
- Do you want to store your source files in a git repository, a directory on Dropbox, OneDrive, or other place that you can just have files?
- Do you want to be able to customize the look-and-feel of your generated site in a simple fashion?
- Do you want to avoid lock-in to a specific site generator?

## Design Principles

Cambium is built on the following design principles:

- You should be able to organize your markdown documents in whatever way you'd like
- Your markdown repository should not have to know that it is being used by Cambium
- Cambium-specific features or macros should be clean and obvious in the markdown
- Cambium should be able to work elegantly on a repository of markdown documents with no configuration
- Your final deployment destination should not matter

## Installation Instructions

To install Cambium, run:

```
pip install cambium
```

