jamstack 2.0.0__py3-none-any.whl

jamstack/themes/blog/static/style.css

@@ -0,0 +1,186 @@
+:root {
+  color-scheme: light dark;
+  --text: #1f1c19;
+  --muted: #756e66;
+  --background: #fbf9f6;
+  --accent: #0f5e59;
+  --rule: #e3ddd4;
+}
+
+@media (prefers-color-scheme: dark) {
+  :root {
+    --text: #ece7e0;
+    --muted: #a49c92;
+    --background: #16130f;
+    --accent: #7cc4bd;
+    --rule: #322c25;
+  }
+}
+
+* {
+  box-sizing: border-box;
+}
+
+body {
+  margin: 0;
+  background: var(--background);
+  color: var(--text);
+  font: 1.125rem/1.75 "Iowan Old Style", "Palatino Linotype", Palatino, Georgia, serif;
+  text-rendering: optimizeLegibility;
+}
+
+.masthead,
+.content,
+.colophon {
+  max-width: 40rem;
+  margin: 0 auto;
+  padding: 0 1.25rem;
+}
+
+.masthead {
+  padding-top: 4rem;
+  padding-bottom: 2.5rem;
+  text-align: center;
+}
+
+.logo {
+  color: var(--text);
+  font-size: 1.75rem;
+  font-weight: 600;
+  letter-spacing: -0.02em;
+  text-decoration: none;
+}
+
+.tagline {
+  margin: 0.5rem 0 0;
+  color: var(--muted);
+  font-size: 0.95rem;
+  font-style: italic;
+}
+
+.content {
+  padding-bottom: 4rem;
+}
+
+a {
+  color: var(--accent);
+}
+
+h1,
+h2,
+h3 {
+  line-height: 1.2;
+  letter-spacing: -0.02em;
+}
+
+h1 {
+  margin: 0 0 0.5rem;
+  font-size: 2.25rem;
+}
+
+time {
+  color: var(--muted);
+  font-size: 0.8rem;
+  letter-spacing: 0.06em;
+  text-transform: uppercase;
+}
+
+.post-list {
+  margin: 0;
+  padding: 0;
+  list-style: none;
+}
+
+.post-list li {
+  padding: 1.75rem 0;
+  border-top: 1px solid var(--rule);
+}
+
+.post-list li:first-child {
+  border-top: none;
+}
+
+.post-title {
+  display: block;
+  color: var(--text);
+  font-size: 1.4rem;
+  font-weight: 600;
+  text-decoration: none;
+}
+
+.post-title:hover {
+  color: var(--accent);
+}
+
+.summary {
+  margin: 0.4rem 0 0;
+  color: var(--muted);
+  font-size: 0.95rem;
+}
+
+.post-header {
+  padding-bottom: 1.5rem;
+  border-bottom: 1px solid var(--rule);
+}
+
+.prose {
+  padding-top: 1.5rem;
+}
+
+.prose p {
+  margin: 0 0 1.25em;
+}
+
+.prose blockquote {
+  margin: 1.5rem 0;
+  padding-left: 1.25rem;
+  border-left: 2px solid var(--rule);
+  color: var(--muted);
+  font-style: italic;
+}
+
+pre,
+code {
+  font-family: ui-monospace, "SF Mono", Menlo, monospace;
+  font-size: 0.85em;
+}
+
+pre {
+  padding: 1rem;
+  overflow-x: auto;
+  background: color-mix(in srgb, var(--text) 6%, transparent);
+  border-radius: 6px;
+}
+
+code {
+  padding: 0.1em 0.3em;
+  background: color-mix(in srgb, var(--text) 7%, transparent);
+  border-radius: 3px;
+}
+
+pre code {
+  padding: 0;
+  background: none;
+}
+
+img {
+  max-width: 100%;
+  height: auto;
+}
+
+.back {
+  margin-top: 3rem;
+  font-size: 0.9rem;
+}
+
+.empty {
+  color: var(--muted);
+}
+
+.colophon {
+  padding-top: 1.25rem;
+  padding-bottom: 3rem;
+  border-top: 1px solid var(--rule);
+  color: var(--muted);
+  font-size: 0.85rem;
+}

jamstack/themes/blog/templates/404.html

@@ -0,0 +1,15 @@
+{% extends "base.html" %}
+
+{% block title %}Page not found · {{ site.title }}{% endblock %}
+
+{% block content %}
+  <article class="post">
+    <header class="post-header">
+      <h1>Page not found</h1>
+    </header>
+    <div class="prose">
+      <p>There is nothing at this address.</p>
+      <p><a href="/">Back to the home page</a></p>
+    </div>
+  </article>
+{% endblock %}

jamstack/themes/blog/templates/base.html

@@ -0,0 +1,22 @@
+<!doctype html>
+<html lang="{{ site.language }}">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>{% block title %}{{ site.title }}{% endblock %}</title>
+    {% if site.description %}<meta name="description" content="{{ site.description }}">{% endif %}
+    <link rel="stylesheet" href="/style.css">
+  </head>
+  <body>
+    <header class="masthead">
+      <a class="logo" href="/">{{ site.title }}</a>
+      {% if site.description %}<p class="tagline">{{ site.description }}</p>{% endif %}
+    </header>
+    <main class="content">
+      {% block content %}{% endblock %}
+    </main>
+    <footer class="colophon">
+      <p>{{ site.title }}</p>
+    </footer>
+  </body>
+</html>

jamstack/themes/blog/templates/index.html

@@ -0,0 +1,21 @@
+{% extends "base.html" %}
+
+{% block content %}
+  {% if page.content %}
+    <div class="intro">{{ page.content }}</div>
+  {% endif %}
+  {% set posts = pages | rejectattr("url", "equalto", "/") | selectattr("date") | list %}
+  {% if posts %}
+    <ol class="post-list">
+      {% for item in posts %}
+        <li>
+          <a class="post-title" href="{{ item.url }}">{{ item.title }}</a>
+          <time datetime="{{ item.date.isoformat() }}">{{ item.date.strftime("%d-%m-%Y") }}</time>
+          {% if item.meta.get("summary") %}<p class="summary">{{ item.meta.get("summary") }}</p>{% endif %}
+        </li>
+      {% endfor %}
+    </ol>
+  {% else %}
+    <p class="empty">No posts yet. Create one in <code>content/posts/</code>.</p>
+  {% endif %}
+{% endblock %}

jamstack/themes/blog/templates/page.html

@@ -0,0 +1,3 @@
+{% extends "post.html" %}
+
+{% block post_footer %}{% endblock %}

jamstack/themes/blog/templates/post.html

@@ -0,0 +1,16 @@
+{% extends "base.html" %}
+
+{% block title %}{{ page.title }} · {{ site.title }}{% endblock %}
+
+{% block content %}
+  <article class="post">
+    <header class="post-header">
+      <h1>{{ page.title }}</h1>
+      {% if page.date %}<time datetime="{{ page.date.isoformat() }}">{{ page.date.strftime("%d-%m-%Y") }}</time>{% endif %}
+    </header>
+    <div class="prose">{{ page.content }}</div>
+    {% block post_footer %}
+      <p class="back"><a href="/">← All posts</a></p>
+    {% endblock %}
+  </article>
+{% endblock %}

jamstack/themes/blog/theme.toml

@@ -0,0 +1,2 @@
+name = "blog"
+description = "A reading-first blog theme with post listings and dates."

jamstack/themes/minimal/static/style.css

@@ -0,0 +1,137 @@
+:root {
+  color-scheme: light dark;
+  --text: #1a1a1a;
+  --muted: #6b6b6b;
+  --background: #fdfdfc;
+  --accent: #2563eb;
+  --rule: #e5e5e2;
+}
+
+@media (prefers-color-scheme: dark) {
+  :root {
+    --text: #e8e8e6;
+    --muted: #a0a0a0;
+    --background: #131313;
+    --accent: #7aa2f7;
+    --rule: #2a2a2a;
+  }
+}
+
+* {
+  box-sizing: border-box;
+}
+
+body {
+  margin: 0;
+  background: var(--background);
+  color: var(--text);
+  font: 1.0625rem/1.7 ui-sans-serif, system-ui, -apple-system, "Segoe UI", sans-serif;
+}
+
+.site-header,
+.site-main,
+.site-footer {
+  max-width: 42rem;
+  margin: 0 auto;
+  padding: 0 1.25rem;
+}
+
+.site-header {
+  padding-top: 2.5rem;
+  padding-bottom: 1rem;
+}
+
+.site-title {
+  color: var(--text);
+  font-size: 1.125rem;
+  font-weight: 700;
+  letter-spacing: -0.01em;
+  text-decoration: none;
+}
+
+.site-main {
+  padding-bottom: 4rem;
+}
+
+h1,
+h2,
+h3 {
+  line-height: 1.25;
+  letter-spacing: -0.02em;
+}
+
+h1 {
+  font-size: 2rem;
+  margin: 1.5rem 0 0.75rem;
+}
+
+a {
+  color: var(--accent);
+}
+
+time {
+  color: var(--muted);
+  font-size: 0.875rem;
+}
+
+.page-list {
+  list-style: none;
+  margin: 2rem 0 0;
+  padding: 0;
+}
+
+.page-list li {
+  display: flex;
+  justify-content: space-between;
+  gap: 1rem;
+  padding: 0.6rem 0;
+  border-top: 1px solid var(--rule);
+}
+
+.page-list a {
+  text-decoration: none;
+}
+
+pre,
+code {
+  font-family: ui-monospace, "SF Mono", Menlo, monospace;
+  font-size: 0.9em;
+}
+
+pre {
+  padding: 1rem;
+  overflow-x: auto;
+  background: color-mix(in srgb, var(--text) 6%, transparent);
+  border-radius: 8px;
+}
+
+code {
+  padding: 0.1em 0.3em;
+  background: color-mix(in srgb, var(--text) 7%, transparent);
+  border-radius: 4px;
+}
+
+pre code {
+  padding: 0;
+  background: none;
+}
+
+blockquote {
+  margin: 1.5rem 0;
+  padding-left: 1rem;
+  border-left: 3px solid var(--rule);
+  color: var(--muted);
+}
+
+img {
+  max-width: 100%;
+  height: auto;
+}
+
+.site-footer {
+  padding-top: 1rem;
+  padding-bottom: 2.5rem;
+  border-top: 1px solid var(--rule);
+  color: var(--muted);
+  font-size: 0.875rem;
+}

jamstack/themes/minimal/templates/404.html

@@ -0,0 +1,11 @@
+{% extends "base.html" %}
+
+{% block title %}Page not found · {{ site.title }}{% endblock %}
+
+{% block content %}
+  <article>
+    <h1>Page not found</h1>
+    <p>There is nothing at this address.</p>
+    <p><a href="/">Back to the home page</a></p>
+  </article>
+{% endblock %}

jamstack/themes/minimal/templates/base.html

@@ -0,0 +1,21 @@
+<!doctype html>
+<html lang="{{ site.language }}">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>{% block title %}{{ site.title }}{% endblock %}</title>
+    {% if site.description %}<meta name="description" content="{{ site.description }}">{% endif %}
+    <link rel="stylesheet" href="/style.css">
+  </head>
+  <body>
+    <header class="site-header">
+      <a class="site-title" href="/">{{ site.title }}</a>
+    </header>
+    <main class="site-main">
+      {% block content %}{% endblock %}
+    </main>
+    <footer class="site-footer">
+      <p>{{ site.title }}{% if site.description %} — {{ site.description }}{% endif %}</p>
+    </footer>
+  </body>
+</html>

jamstack/themes/minimal/templates/index.html

@@ -0,0 +1,17 @@
+{% extends "base.html" %}
+
+{% block content %}
+  <h1>{{ page.title }}</h1>
+  {{ page.content }}
+  {% set listed = pages | rejectattr("url", "equalto", "/") | list %}
+  {% if listed %}
+    <ul class="page-list">
+      {% for item in listed %}
+        <li>
+          <a href="{{ item.url }}">{{ item.title }}</a>
+          {% if item.date %}<time datetime="{{ item.date.isoformat() }}">{{ item.date.strftime("%d-%m-%Y") }}</time>{% endif %}
+        </li>
+      {% endfor %}
+    </ul>
+  {% endif %}
+{% endblock %}

jamstack/themes/minimal/templates/page.html

@@ -0,0 +1,11 @@
+{% extends "base.html" %}
+
+{% block title %}{{ page.title }} · {{ site.title }}{% endblock %}
+
+{% block content %}
+  <article>
+    <h1>{{ page.title }}</h1>
+    {% if page.date %}<time datetime="{{ page.date.isoformat() }}">{{ page.date.strftime("%d-%m-%Y") }}</time>{% endif %}
+    {{ page.content }}
+  </article>
+{% endblock %}

jamstack/themes/minimal/theme.toml

@@ -0,0 +1,2 @@
+name = "minimal"
+description = "A clean, responsive starting point for small sites."

jamstack-2.0.0.dist-info/METADATA

@@ -0,0 +1,216 @@
+Metadata-Version: 2.5
+Name: jamstack
+Version: 2.0.0
+Summary: Static site generator built on Python and Jinja
+Project-URL: Homepage, https://github.com/jamstackpy/jamstack
+Project-URL: Source, https://github.com/jamstackpy/jamstack
+Project-URL: Issues, https://github.com/jamstackpy/jamstack/issues
+Project-URL: Changelog, https://github.com/jamstackpy/jamstack/blob/stable/CHANGELOG.md
+Author-email: Abdur-Rahmaan Janhangeer <arj.python@gmail.com>, Pedro Torcatt <pedrotorcattsoto@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: jinja,python,ssg,static site generator
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
+Requires-Python: >=3.11
+Requires-Dist: click>=8.1
+Requires-Dist: jinja2>=3.1
+Requires-Dist: markdown-it-py>=3.0
+Provides-Extra: dev
+Requires-Dist: commitizen>=4.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.7; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.17; extra == 'dev'
+Requires-Dist: zensical>=0.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <img alt="Jamstack logo" src="https://i.imgur.com/sXUAdYJ.png" height="217" />
+
+  <p>A small static site generator built on Python and Jinja.</p>
+</div>
+
+[![CI](https://github.com/jamstackpy/jamstack/actions/workflows/ci.yml/badge.svg?branch=stable)](https://github.com/jamstackpy/jamstack/actions/workflows/ci.yml)
+![PyPI](https://img.shields.io/pypi/v/jamstack)
+![Python 3.11+](https://img.shields.io/badge/python-3.11%2B-blue)
+
+## Documentation
+
+The full documentation lives in [`docs/`](docs/) and is built with Zensical.
+Preview it locally with `zensical serve`; it is published at
+<https://jamstackpy.github.io/>.
+
+Jamstack turns a folder of Markdown and Jinja templates into a static site.
+There is no database, no runtime, and no network access during a build: you
+write content, run one command, and deploy the generated `dist/` folder
+anywhere.
+
+## Features
+
+- Markdown pages with TOML front matter, or raw Jinja templates when you need
+  full control.
+- Themes as plain folders: bundled ones, your own, or a per-project override.
+- A development server that rebuilds on change and keeps the last good build
+  when something fails.
+- `sitemap.xml`, an Atom feed, and a themed `404.html` generated for you.
+- Deterministic output: the same sources always produce the same bytes.
+- Three runtime dependencies: `click`, `jinja2`, `markdown-it-py`.
+
+## Installation
+
+```bash
+python -m pip install jamstack
+```
+
+Python 3.11 or newer is required.
+
+## Quick start
+
+```bash
+jamstack init my-site --theme blog
+cd my-site
+jamstack build
+jamstack serve
+```
+
+`jamstack init` scaffolds `site.toml`, a starter page, and the files the chosen
+theme needs. `jamstack build` writes the site to `dist/`. `jamstack serve`
+serves it at `http://127.0.0.1:8000` and rebuilds when a source changes.
+
+## Project layout
+
+```
+my-site/
+  site.toml          # site configuration
+  content/           # pages (.md or .html)
+  static/            # files copied as-is to the output root
+  templates/         # optional overrides of the theme's templates
+  themes/            # optional local themes
+  dist/              # build output (do not edit)
+```
+
+## Writing content
+
+A page is a file under `content/`. Its path becomes its URL:
+
+| Source | URL | Output |
+| --- | --- | --- |
+| `content/index.md` | `/` | `dist/index.html` |
+| `content/about.md` | `/about/` | `dist/about/index.html` |
+| `content/posts/hello.md` | `/posts/hello/` | `dist/posts/hello/index.html` |
+
+Markdown files may start with TOML front matter delimited by `+++`:
+
+```markdown
++++
+title = "Hello, world"
+date = 2026-11-06
+summary = "The first post."
++++
+
+This is **Markdown**.
+```
+
+Recognised keys:
+
+| Key | Type | Meaning |
+| --- | --- | --- |
+| `title` | string | Page title. Defaults to the file name. |
+| `date` | ISO date | Publication date. Feeds and listings order by it. |
+| `template` | string | Template to render the page with. |
+| `draft` | boolean | Excluded from builds unless `--drafts` is passed. |
+| `summary` | string | Short description used by feeds and the blog theme. |
+
+Any other key is available to templates as `page.meta`. Files ending in
+`.html` are rendered as Jinja templates instead of Markdown, which makes it
+easy to build landing pages with custom markup.
+
+## Configuration
+
+```toml
+[site]
+title = "My Site"                 # required
+description = ""
+author = ""
+base_url = "https://example.com"  # required for sitemap.xml and feed.xml
+language = "en"
+
+[build]
+output = "dist"
+
+[theme]
+name = "blog"
+```
+
+`base_url` must be the public, absolute URL of the site. When it is set,
+Jamstack writes `sitemap.xml` with every page and `feed.xml` with every dated
+page. When it is empty, both files are skipped rather than emitting relative
+URLs.
+
+## Themes
+
+List the available themes with:
+
+```bash
+jamstack themes
+```
+
+Two themes ship with the package: `minimal` for small sites and `blog` for
+dated posts. A project can override a bundled theme by creating
+`themes/<name>/` inside the project; local themes take precedence.
+
+Themes are plain folders, so a custom theme is just a directory with a
+`theme.toml`, `templates/`, and optionally `static/` and `scaffold/`. See
+[docs/themes.md](docs/themes.md) for the full specification.
+
+## Command reference
+
+| Command | Description |
+| --- | --- |
+| `jamstack init [PATH] [--theme NAME] [--force]` | Create a new site. |
+| `jamstack build [--clean] [--drafts]` | Build the site into `dist/`. |
+| `jamstack serve [--port PORT] [--drafts]` | Build, serve, and rebuild on change. |
+| `jamstack themes` | List available themes. |
+| `jamstack --version` | Print the installed version. |
+
+`python -m jamstack` behaves like the `jamstack` command.
+
+## Migrating from 1.x
+
+The 1.x engine (`settings.py`, `posts.json`, `static.py`, html5up themes) is
+replaced entirely in 2.0. See [docs/migration.md](docs/migration.md) for a
+step-by-step conversion guide, or keep using 1.x with:
+
+```bash
+python -m pip install "jamstack<2"
+```
+
+## Development
+
+```bash
+git clone git@github.com:jamstackpy/jamstack.git
+cd jamstack
+git switch stable
+python -m venv .venv
+. .venv/bin/activate
+pip install -e ".[dev]"
+pre-commit install --hook-type pre-commit --hook-type commit-msg
+pytest
+```
+
+Commits follow [Conventional Commits](https://www.conventionalcommits.org/);
+see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+MIT. The 1.x html5up templates were distributed under CC BY 3.0 and are no
+longer part of this branch.